pipeline.hifa.tasks.sessionrefant package¶

Submodules¶

pipeline.hifa.tasks.sessionrefant.qa module¶

class pipeline.hifa.tasks.sessionrefant.qa.SessionRefAntListQAHandler[source]¶

Bases: pipeline.infrastructure.pipelineqa.QAPlugin

QA plugin to process lists of SessionRefAntResults.

child_cls¶: alias of pipeline.hifa.tasks.sessionrefant.resultobjects.SessionRefAntResults

generating_task¶: alias of pipeline.hifa.tasks.sessionrefant.sessionrefant.SessionRefAnt

handle(context, result)[source]¶

result_cls¶: alias of collections.abc.Iterable

class pipeline.hifa.tasks.sessionrefant.qa.SessionRefAntQAHandler[source]¶

Bases: pipeline.infrastructure.pipelineqa.QAPlugin

QA plugin to handle a singular SessionRefAntResults.

This plugin creates a score for each session in the results, based on whether a final best reference antenna was found for the session.

child_cls = None¶

generating_task¶: alias of pipeline.hifa.tasks.sessionrefant.sessionrefant.SessionRefAnt

handle(context, result: pipeline.hifa.tasks.sessionrefant.resultobjects.SessionRefAntResults)[source]¶

result_cls¶: alias of pipeline.hifa.tasks.sessionrefant.resultobjects.SessionRefAntResults

pipeline.hifa.tasks.sessionrefant.renderer module¶

class pipeline.hifa.tasks.sessionrefant.renderer.T2_4MDetailsSessionRefAntRenderer(uri='sessionrefant.mako', description='Select reference antenna for session(s)', always_rerender=False)[source]¶

Bases: pipeline.infrastructure.renderer.basetemplates.T2_4MDetailsDefaultRenderer

update_mako_context(mako_context, pipeline_context, results)[source]¶

pipeline.hifa.tasks.sessionrefant.resultobjects module¶

class pipeline.hifa.tasks.sessionrefant.resultobjects.SessionRefAntResults[source]¶

Bases: pipeline.infrastructure.basetask.Results

merge_with_context(context)[source]¶: See :method:`~pipeline.api.Results.merge_with_context`

pipeline.hifa.tasks.sessionrefant.sessionrefant module¶

class pipeline.hifa.tasks.sessionrefant.sessionrefant.SessionRefAnt(inputs)[source]¶

Bases: pipeline.infrastructure.basetask.StandardTaskTemplate

Inputs¶: alias of SessionRefAntInputs

analyse(result)[source]¶

Determine the best parameters by analysing the given jobs before returning any final jobs to execute.

Parameters: jobs (a list ofJobRequest) – the job requests generated by prepare()
Return type: Result

is_multi_vis_task = True¶

prepare(**parameters)[source]¶

Prepare job requests for execution.

Parameters: parameters – the parameters to pass through to the subclass. Refer to the implementing subclass for specific information on what these parameters are.
Return type: a class implementing Result

class pipeline.hifa.tasks.sessionrefant.sessionrefant.SessionRefAntInputs(context, output_dir=None, vis=None, phase_threshold=None)[source]¶

Bases: pipeline.infrastructure.vdp.StandardInputs

SessionRefAntInputs defines the inputs for the SessionRefAnt pipeline task.

phase_threshold¶

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:

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.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
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])

class pipeline.hifa.tasks.sessionrefant.sessionrefant.SessionRefAntResults[source]¶