Package schrodinger :: Package application :: Package matsci :: Package nano :: Module particle :: Class CheckInput

Class CheckInput

object --+
         |
        CheckInput

Manage checking user input.

Instance Methods

[hide private]

checkShapeParams(self, shape, params, logger=None)
Check the specified shape and shape parameters.

dict, dict

checkAlignment(self, shape, primary_alignment, secondary_alignment, logger=None)
Check the specified alignment.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

checkShapeParams(self, shape, params, logger=None)

Check the specified shape and shape parameters.

Parameters:

shape (str) - the shape of nanoparticle
params (list) - contains floats specifying the shapes geometry
logger (logging.Logger) - output logger

checkAlignment(self, shape, primary_alignment, secondary_alignment, logger=None)

Check the specified alignment.

Parameters:

shape (str) - the shape of nanoparticle
primary_alignment (dict) - dictionary defining the primary alignment
secondary_alignment (dict) - dictionary defining the secondary alignment
logger (logging.Logger) - output logger

Returns: dict, dict

the final primary and secondary alignment dictionaries