pipeline.hifa.tasks.polcalflag package

Submodules

pipeline.hifa.tasks.polcalflag.polcalflag module

class pipeline.hifa.tasks.polcalflag.polcalflag.AmpVsXChart(xaxis, context, output_dir, calto, **overrides)

Bases: pipeline.h.tasks.common.displays.applycal.SpwSummaryChart

Plotting class that creates an amplitude vs X plot for each spw, where X is given as a constructor argument.

class pipeline.hifa.tasks.polcalflag.polcalflag.Polcalflag(inputs)

Bases: pipeline.infrastructure.basetask.StandardTaskTemplate

Inputs

alias of PolcalflagInputs

analyse(results)

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

prepare()

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.polcalflag.polcalflag.PolcalflagInputs(context, vis=None)

Bases: pipeline.infrastructure.vdp.StandardInputs

intent

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])

minsnr

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])

phaseupsolint

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])

refant

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])

solint

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])

class pipeline.hifa.tasks.polcalflag.polcalflag.PolcalflagResults

Bases: pipeline.infrastructure.basetask.Results

merge_with_context(context)

See :method:`~pipeline.infrastructure.api.Results.merge_with_context`

pipeline.hifa.tasks.polcalflag.polcalflag.create_plots(inputs, context, suffix='')

Return amplitude vs time plots for the given data column.

Parameters

• inputs – pipeline inputs

• context – pipeline context

• suffix – optional component to add to the plot filenames

Returns

dict of (x axis type => str, [plots,…])

pipeline.hifa.tasks.polcalflag.qa module

class pipeline.hifa.tasks.polcalflag.qa.PolcalflagListQAHandler

Bases: pipeline.infrastructure.pipelineqa.QAPlugin

QA handler for a list containing PolcalflagResults.

child_cls

alias of pipeline.hifa.tasks.polcalflag.polcalflag.PolcalflagResults

handle(context, result)

result_cls

alias of pipeline.infrastructure.basetask.ResultsList

class pipeline.hifa.tasks.polcalflag.qa.PolcalflagQAHandler

Bases: pipeline.infrastructure.pipelineqa.QAPlugin

QA handler for an uncontained PolcalflagResults.

child_cls = None

handle(context, result)

result_cls

alias of pipeline.hifa.tasks.polcalflag.polcalflag.PolcalflagResults

pipeline.hifa.tasks.polcalflag.renderer module

Created on 25 Mar 2020

@author: Dirk Muders (MPIfR)

pipeline.hifa.tasks.polcalflag.renderer.FlagTotal

alias of pipeline.hifa.tasks.polcalflag.renderer.FlagSummary

class pipeline.hifa.tasks.polcalflag.renderer.T2_4MDetailsPolcalflagRenderer(uri='polcalflag.mako', description='Polcal outlier flagging', always_rerender=False)

Bases: pipeline.infrastructure.renderer.basetemplates.T2_4MDetailsDefaultRenderer

Renders detailed HTML output for the PolcalFlag task.

update_mako_context(mako_context, pipeline_context, results)

Module contents

class pipeline.hifa.tasks.polcalflag.Polcalflag(inputs)

Bases: pipeline.infrastructure.basetask.StandardTaskTemplate

Inputs

alias of PolcalflagInputs

analyse(results)

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

prepare()

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