pipeline.hifas.tasks.imageprecheck package

Submodules

pipeline.hifas.tasks.imageprecheck.imageprecheck module

class pipeline.hifas.tasks.imageprecheck.imageprecheck.ImagePreCheck(inputs)

Bases: pipeline.hifa.tasks.imageprecheck.imageprecheck.ImagePreCheck

Inputs

alias of ImagePreCheckInputs

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

calc_uvtaper(beam_natural=None, beam_user=None, l80=None, repr_freq=None)

This code will take a given beam and a desired beam size and calculate the necessary UV-tapering parameters needed for tclean to recreate that beam.

UV-tapering parameter larger than the 80 percentile baseline is not allowed.

Parameters

• beam_natural – natural beam, dictionary with major, minor and positionangle keywords

• beam_user – desired beam, dictionary with major, minor and positionangle keywords

• l80 – 80th percentile baseline in meters. uvtaper larger than this baseline is not allowed

• repr_freq – representative frequency, dictionary with unit and value keywords.

Returns

uv_taper needed to recreate user_beam in tclean

is_multi_vis_task = True

prepare()

Differences compared to base task (hifa_task_imageprecheck.ImagePreCheck) prepare method:

• user speciefed angular resultion goal can be set via inputs.desired_angular_resolution

• uvtaper is computed if the best robust is 2.0 and inputs.desired_angular_resolution was set

• return best robust if repr_target=False, base method returns robust=0.5 in this case

• if repr_target=False and best robust value is 2.0, then compute and return uvtaper

class pipeline.hifas.tasks.imageprecheck.imageprecheck.ImagePreCheckInputs(context, vis=None, desired_angular_resolution=None, calcsb=None, parallel=None)

Bases: pipeline.infrastructure.vdp.StandardInputs

calcsb

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

desired_angular_resolution

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

parallel

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.hifas.tasks.imageprecheck.imageprecheck.ImagePreCheckResults(real_repr_target=False, repr_target='', repr_source='', repr_spw=None, reprBW_mode=None, reprBW_nbin=None, minAcceptableAngResolution='0.0arcsec', maxAcceptableAngResolution='0.0arcsec', maxAllowedBeamAxialRatio=0.0, user_minAcceptableAngResolution='0.0arcsec', user_maxAcceptableAngResolution='0.0arcsec', user_maxAllowedBeamAxialRatio=0.0, sensitivityGoal='0mJy', hm_robust=0.5, hm_uvtaper=[], sensitivities=None, sensitivity_bandwidth=None, score=None, single_continuum=False, per_spw_cont_sensitivities_all_chan=None, synthesized_beams=None, beamRatios=None, error=False, error_msg=None)

Bases: pipeline.hifa.tasks.imageprecheck.imageprecheck.ImagePreCheckResults

merge_with_context(context)

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

Module contents