StandardInputs

class StandardInputs

Bases: Inputs

Attributes Summary

context	Get the context used as the base for the parameters for this Inputs.
ms	VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
output_dir	VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
processing_data_type
vis	VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.

Methods Summary

as_dict()
to_casa_args()	Express these inputs as a dictionary of CASA arguments.

Attributes Documentation

context

Get the context used as the base for the parameters for this Inputs.

Return type:

Context

ms

VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.

On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:

1. If a NullMarker is found - signifying that no user input has been provided - and a 'getter' function has been defined, the getter function will be called to provide a default value for that measurement set.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.

A VisDependentProperty can be made read-only by specifying 'readonly=True' when creating the instance.

A VisDependentProperty can be hidden from the containing Inputs string representation by setting 'hidden=True' when creating the instance. This will hide the property from the web log and CLI getInputs calls.

Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,

solint = @VisDependentProperty(default=5, null_input=[None, '', 'RESET', -1])

output_dir

VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.

On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:

1. If a NullMarker is found - signifying that no user input has been provided - and a 'getter' function has been defined, the getter function will be called to provide a default value for that measurement set.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.

A VisDependentProperty can be made read-only by specifying 'readonly=True' when creating the instance.

A VisDependentProperty can be hidden from the containing Inputs string representation by setting 'hidden=True' when creating the instance. This will hide the property from the web log and CLI getInputs calls.

Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,

solint = @VisDependentProperty(default=5, null_input=[None, '', 'RESET', -1])

processing_data_type = [DataType.RAW]

vis

VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.

On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:

1. If a NullMarker is found - signifying that no user input has been provided - and a 'getter' function has been defined, the getter function will be called to provide a default value for that measurement set.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.

A VisDependentProperty can be made read-only by specifying 'readonly=True' when creating the instance.

A VisDependentProperty can be hidden from the containing Inputs string representation by setting 'hidden=True' when creating the instance. This will hide the property from the web log and CLI getInputs calls.

Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,

solint = @VisDependentProperty(default=5, null_input=[None, '', 'RESET', -1])

Methods Documentation

as_dict()

to_casa_args()

Express these inputs as a dictionary of CASA arguments. The values in the dictionary are in a format suitable for CASA and can be directly passed to the CASA task.

Return type:

a dictionary of string/??? kw/val pairs