Accessor Methods

The following methods are available for accessing the 'instance' data.

group

This method returns the group name associated with the observation.

  $group_name = $Frm->group;
  $Frm->group("group");

This can be configured initially using the findgroup() method. Alternatively, findgroup() is run automatically by the configure() method.

framegroupkeys

Returns the FITS header keys that should be used to group files into distinct Frame objects. Used by the framegroup method to determine grouping.

Returns empty list in the base class.

is_frame

Whether or not the current object is an ORAC::Frame object.

  $is_frame = $self->is_frame;

Returns 1.

isgood

Flag to determine the current state of the frame. If isgood() is true the Frame is valid. If it returns false the frame object may have a problem (eg the recipe responsible for processing the frame failed to complete).

This flag is used by the ORAC::Group class to determine membership.

nsubs

Return the number of sub-frames associated with this frame.

nfiles() should be used to return the current number of sub-frames associated with the frame (nsubs usually only reports the number given in the header and may or may not be the same as the number of sub-frames currently stored)

Usually this value is set as part of the configure() method from the header (using findnsubs()) or by using findnsubs() directly.

rawfixedpart

Return (or set) the constant part of the raw filename associated with the raw data file. (ie the bit that stays fixed for every observation)

  $fixed = $self->rawfixedpart;

rawformat

Data format associated with the raw() data file. Usually one of 'NDF', 'HDS' or 'FITS'. This format should be recognisable by ORAC::Convert.

rawsuffix

Return (or set) the file name suffix associated with the raw data file.

  $suffix = $self->rawsuffix;

recipe

This method returns the recipe name associated with the observation. The recipe name can be set explicitly but in general should be set by the findrecipe() method.

  $recipe_name = $Frm->recipe;
  $Frm->recipe("recipe");

This can be configured initially using the findrecipe() method. Alternatively, findrecipe() is run automatically by the configure() method.

tempraw

An array of flags, one per raw file, indicating whether the raw file is temporary, and so can be deleted, or real data (don't want to delete it).

  $Frm->tempraw( @istemp );
  @istemp = $Frm->tempraw;

If a single value is given, it will be applied to all raw files

  $Frm->tempraw( 1 );

In scalar context returns true if all frames are temporary, false if all frames are permanent and undef if some frames are temporary whilst others are permanent.

  $alltemp = $Frm->tempraw();