nikamap.NikaMap

class nikamap.NikaMap(data, *args, **kwargs)[source]

A NikaMap object represent a nika map with additionnal capabilities.

It contains the metadata, wcs, and all attribute (data/stddev/time/unit/mask) as well as potential source list detected in these maps.

Parameters:

  • data (ndarray or astropy.nddata.NDData) – The actual data contained in this NDData object. Not that this will always be copies by reference , so you should make copy the data before passing it in if that’s the desired behavior.

  • uncertainty (astropy.nddata.NDUncertainty, optional) – Uncertainties on the data.

  • mask (ndarray-like, optional) – Mask for the data, given as a boolean Numpy array or any object that can be converted to a boolean Numpy array with a shape matching that of the data. The values must be False where the data is valid and True when it is not (like Numpy masked arrays). If data is a numpy masked array, providing mask here will causes the mask from the masked array to be ignored.

  • hits (ndarray-like, optional) – The hit per pixel on the map

  • sampling_freq (float or Quantity) – the sampling frequency of the experiment, default 1 Hz

  • wcs (undefined, optional) – WCS-object containing the world coordinate system for the data.

  • meta (dict-like object, optional) – Metadata for this object. “Metadata” here means all information that is included with this object but not part of any other attribute of this particular object. e.g., creation date, unique identifier, simulation parameters, exposure time, telescope name, etc.

  • unit (astropy.units.UnitBase instance or str, optional) – The units of the data.

  • beam (radio_beam.Beam) – The beam corresponding to the data, by default a gaussian constructed from the header ‘BMAJ’ ‘BMIN’, ‘PA’ keyword.

  • fake_source (astropy.table.Table, optional) –

    The table of potential fake sources included in the data

    Note

    The table must contain at least 3 columns: [‘ID’, ‘ra’, ‘dec’]

  • sources (:class`astropy.table.Table`, optional) – The table of detected sources in the data.