sierra.core.variables.variable_density

• VariableDensity: A univariate range for variable density (# THINGS/m^2).

• Parser: Enforces specification of a VariableDensity derived batch criteria.

class sierra.core.variables.variable_density.VariableDensity(cli_arg: str, main_config: Dict[str, Any], batch_input_root: Path, densities: List[float], extent: ArenaExtent)

A univariate range for variable density (# THINGS/m^2).

# THINGS is varied as arena size is held constant. This class is a base class which should NEVER be used on its own.

densities

List of densities to use.

dist_type

The type of block distribution to use.

changes

List of sets of changes to apply to generate the specified arena sizes.

Inheritance

__doc__ = 'A univariate range for variable density (# THINGS/m^2).\n\n    # THINGS is varied as arena size is held constant. This class is a base\n    class which should NEVER be used on its own.\n\n    Attributes:\n\n        densities: List of densities to use.\n\n        dist_type: The type of block distribution to use.\n\n        changes: List of sets of changes to apply to generate the specified\n                 arena sizes.\n\n    '

__init__(cli_arg: str, main_config: Dict[str, Any], batch_input_root: Path, densities: List[float], extent: ArenaExtent) → None

__module__ = 'sierra.core.variables.variable_density'

class sierra.core.variables.variable_density.Parser

Enforces specification of a VariableDensity derived batch criteria.

Inheritance

__call__(arg: str) → Dict[str, Any]

Parse the cmdline argument.

Returns:

density_min: Floating point value of target minimum density. density_max: Floating point value of target maximum density. cardinality: # densities in [min,max] that should be created.

Return type:

dict

__dict__ = mappingproxy({'__module__': 'sierra.core.variables.variable_density', '__doc__': 'Enforces specification of a :class:`VariableDensity` derived batch criteria.\n\n    ', '__call__': <function Parser.__call__>, '_parse_density': <staticmethod object>, '__dict__': <attribute '__dict__' of 'Parser' objects>, '__weakref__': <attribute '__weakref__' of 'Parser' objects>, '__annotations__': {}})

__doc__ = 'Enforces specification of a :class:`VariableDensity` derived batch criteria.\n\n    '

__module__ = 'sierra.core.variables.variable_density'

__weakref__

list of weak references to the object (if defined)

static _parse_density(chunk: str, which: str) → float