lsst::afw::image::ExposureFitsReader Class Reference

A FITS reader class for Exposures and their components. More...

#include <ExposureFitsReader.h>

Classes
class	ArchiveReader
class	MetadataReader

Public Member Functions
	ExposureFitsReader (std::string const &fileName)
	Construct a FITS reader object.
	ExposureFitsReader (fits::MemFileManager &manager)
	Construct a FITS reader object.
	ExposureFitsReader (fits::Fits *fitsFile)
	Construct a FITS reader object.
	ExposureFitsReader (ExposureFitsReader const &)=delete
	ExposureFitsReader (ExposureFitsReader &&)=delete
ExposureFitsReader &	operator= (ExposureFitsReader const &)=delete
ExposureFitsReader &	operator= (ExposureFitsReader &&)=delete
	~ExposureFitsReader () noexcept
lsst::geom::Box2I	readBBox (ImageOrigin origin=PARENT)
	Read the bounding box of the on-disk image.
lsst::geom::Point2I	readXY0 (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT)
	Read the image origin from the on-disk image or a subimage thereof.
int	readSerializationVersion ()
	Read the serialization version number from the header.
std::shared_ptr< daf::base::PropertyList >	readMetadata ()
	Read the flexible metadata associated with the Exposure.
std::optional< table::RecordId >	readExposureId ()
	Read the Exposure's exposure ID, if it exists.
std::shared_ptr< afw::geom::SkyWcs >	readWcs ()
	Read the Exposure's world coordinate system.
std::shared_ptr< FilterLabel >	readFilter ()
	Read the Exposure's filter information.
std::shared_ptr< PhotoCalib >	readPhotoCalib ()
	Read the Exposure's photometric calibration.
std::shared_ptr< detection::Psf >	readPsf ()
	Read the Exposure's point-spread function.
std::shared_ptr< afw::geom::polygon::Polygon >	readValidPolygon ()
	Read the polygon describing the region of validity for the Exposure.
std::shared_ptr< ApCorrMap >	readApCorrMap ()
	Read the Exposure's aperture correction map.
std::shared_ptr< CoaddInputs >	readCoaddInputs ()
	Read the Exposure's coadd input catalogs.
std::shared_ptr< VisitInfo >	readVisitInfo ()
	Read the Exposure's visit metadata.
std::shared_ptr< TransmissionCurve >	readTransmissionCurve ()
	Read the Exposure's transmission curve.
std::shared_ptr< cameraGeom::Detector >	readDetector ()
	Read the Exposure's detector.
std::shared_ptr< typehandling::Storable >	readComponent (std::string const &componentName)
	Read an arbitrary non-standard component by name.
std::map< std::string, std::shared_ptr< table::io::Persistable > >	readExtraComponents ()
	Read the Exposure's non-standard components.
std::shared_ptr< ExposureInfo >	readExposureInfo ()
	Read the ExposureInfo containing all non-image components.
template<typename MaskPixelT >
Mask< MaskPixelT >	readMask (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
	Read the mask plane.
template<typename MaskPixelT >
ndarray::Array< MaskPixelT, 2, 2 >	readMaskArray (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
	Read the mask plane.
template<typename ImagePixelT , typename MaskPixelT = MaskPixel, typename VariancePixelT = VariancePixel>
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >	readMaskedImage (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
	Read the MaskedImage.
template<typename ImagePixelT , typename MaskPixelT = MaskPixel, typename VariancePixelT = VariancePixel>
Exposure< ImagePixelT, MaskPixelT, VariancePixelT >	read (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
	Read the full Exposure.
std::string	getFileName () const
	Return the name of the file this reader targets.
std::string	readImageDType () const
	Read a string describing the pixel type of the on-disk image plane.
std::string	readMaskDType () const
	Read a string describing the pixel type of the on-disk image plane.
std::string	readVarianceDType () const
	Read a string describing the pixel type of the on-disk image plane.
template<typename ImagePixelT >
Image< ImagePixelT >	readImage (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
	Read the image plane.
template<typename ImagePixelT >
ndarray::Array< ImagePixelT, 2, 2 >	readImageArray (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
	Read the image plane.
template<typename VariancePixelT >
Image< VariancePixelT >	readVariance (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
	Read the variance plane.
template<typename VariancePixelT >
ndarray::Array< VariancePixelT, 2, 2 >	readVarianceArray (lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
	Read the variance plane.

Detailed Description

A FITS reader class for Exposures and their components.

Exception Safety

All ExposureFitsReader methods provide strong exception safety, but exceptions thrown by the internal fits::Fits object itself may change its status variable or HDU pointer; ExposureFitsReader guards against this by resetting those before any use of the Fits object.

Definition at line 44 of file ExposureFitsReader.h.

Constructor & Destructor Documentation

ExposureFitsReader() [1/5]

lsst::afw::image::ExposureFitsReader::ExposureFitsReader ( std::string const & fileName )

explicit

Construct a FITS reader object.

Parameters

fileName

Name of a file to open.

Definition at line 387 of file ExposureFitsReader.cc.

: _maskedImageReader(fileName) {}

ExposureFitsReader() [2/5]

lsst::afw::image::ExposureFitsReader::ExposureFitsReader ( fits::MemFileManager & manager )

explicit

Construct a FITS reader object.

Parameters

manager

Memory block containing a FITS file.

Definition at line 389 of file ExposureFitsReader.cc.

: _maskedImageReader(manager) {}

ExposureFitsReader() [3/5]

lsst::afw::image::ExposureFitsReader::ExposureFitsReader ( fits::Fits * fitsFile )

explicit

Construct a FITS reader object.

Parameters

fitsFile

Pointer to a CFITSIO file object. Lifetime will not be managed by the Reader object.

Definition at line 391 of file ExposureFitsReader.cc.

: _maskedImageReader(fitsFile) {}

ExposureFitsReader() [4/5]

lsst::afw::image::ExposureFitsReader::ExposureFitsReader ( ExposureFitsReader const & )

delete

ExposureFitsReader() [5/5]

lsst::afw::image::ExposureFitsReader::ExposureFitsReader ( ExposureFitsReader && )

delete

~ExposureFitsReader()

lsst::afw::image::ExposureFitsReader::~ExposureFitsReader ( )

defaultnoexcept

Member Function Documentation

getFileName()

std::string lsst::afw::image::ExposureFitsReader::getFileName ( ) const

inline

Return the name of the file this reader targets.

Definition at line 289 of file ExposureFitsReader.h.

{ return _maskedImageReader.getFileName(); }

operator=() [1/2]

ExposureFitsReader & lsst::afw::image::ExposureFitsReader::operator= ( ExposureFitsReader && )

delete

operator=() [2/2]

ExposureFitsReader & lsst::afw::image::ExposureFitsReader::operator= ( ExposureFitsReader const & )

delete

read()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >

template Exposure< std::uint64_t, MaskPixel, VariancePixel > lsst::afw::image::ExposureFitsReader::read	(	lsst::geom::Box2I const &	bbox = lsst::geom::Box2I(),
		ImageOrigin	origin = PARENT,
		bool	conformMasks = false,
		bool	allowUnsafe = false )

Read the full Exposure.

Parameters

bbox	A bounding box used to defined a subimage, or an empty box (default) to read the whole image.
origin	Coordinate system convention for the given box.
conformMasks	If True, conform the global mask dict to match this file.
allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

In Python, this templated method is wrapped with an additional dtype argument to provide the type to read (for the image plane). This defaults to the type of the on-disk image.

Definition at line 625 of file ExposureFitsReader.cc.

                                                                                             {
    auto mi =
            readMaskedImage<ImagePixelT, MaskPixelT, VariancePixelT>(bbox, origin, conformMasks, allowUnsafe);
    return Exposure<ImagePixelT, MaskPixelT, VariancePixelT>(mi, readExposureInfo());
}

readApCorrMap()

std::shared_ptr< ApCorrMap > lsst::afw::image::ExposureFitsReader::readApCorrMap

(

)

Read the Exposure's aperture correction map.

Definition at line 462 of file ExposureFitsReader.cc.

                                                           {
    _ensureReaders();
    return _archiveReader->readComponent<ApCorrMap>(_getFitsFile(), ArchiveReader::AP_CORR_MAP);
}

readBBox()

lsst::geom::Box2I lsst::afw::image::ExposureFitsReader::readBBox

(

ImageOrigin

origin = PARENT

)

Read the bounding box of the on-disk image.

Parameters

origin

Coordinate system convention for the returned box. If LOCAL, the returned box will always have a minimum of (0, 0).

Definition at line 395 of file ExposureFitsReader.cc.

                                                             {
    return _maskedImageReader.readBBox(origin);
}

readCoaddInputs()

std::shared_ptr< CoaddInputs > lsst::afw::image::ExposureFitsReader::readCoaddInputs

(

)

Read the Exposure's coadd input catalogs.

Definition at line 467 of file ExposureFitsReader.cc.

                                                               {
    _ensureReaders();
    return _archiveReader->readComponent<CoaddInputs>(_getFitsFile(), ArchiveReader::COADD_INPUTS);
}

readComponent()

std::shared_ptr< typehandling::Storable > lsst::afw::image::ExposureFitsReader::readComponent

(

std::string const &

componentName

)

Read an arbitrary non-standard component by name.

Definition at line 488 of file ExposureFitsReader.cc.

                                                                                                    {
    _ensureReaders();
    return _archiveReader->readComponent<typehandling::Storable>(_getFitsFile(), componentName);
}

readDetector()

std::shared_ptr< cameraGeom::Detector > lsst::afw::image::ExposureFitsReader::readDetector

(

)

Read the Exposure's detector.

Definition at line 483 of file ExposureFitsReader.cc.

                                                                   {
    _ensureReaders();
    return _archiveReader->readComponent<cameraGeom::Detector>(_getFitsFile(), ArchiveReader::DETECTOR);
}

readExposureId()

std::optional< table::RecordId > lsst::afw::image::ExposureFitsReader::readExposureId

(

)

Read the Exposure's exposure ID, if it exists.

Definition at line 419 of file ExposureFitsReader.cc.

                                                              {
    _ensureReaders();
    return _metadataReader->exposureId;
}

readExposureInfo()

std::shared_ptr< ExposureInfo > lsst::afw::image::ExposureFitsReader::readExposureInfo

(

)

Read the ExposureInfo containing all non-image components.

Definition at line 498 of file ExposureFitsReader.cc.

                                                                 {
    auto result = std::make_shared<ExposureInfo>();
    result->setMetadata(readMetadata());
    result->setPhotoCalib(readPhotoCalib());
    result->setVisitInfo(readVisitInfo());
    // Override ID set in visitInfo, if necessary
    std::optional<table::RecordId> exposureId = readExposureId();
    if (exposureId) {
        result->setId(*exposureId);
    }
    // When reading an ExposureInfo (as opposed to reading individual
    // components), we warn and try to proceed when a component is present
    // but can't be read due its serialization factory not being set up
    // (that's what throws the NotFoundErrors caught below).
    try {
        result->setPsf(readPsf());
    } catch (pex::exceptions::NotFoundError& err) {
        LOGLS_WARN(_log, "Could not read PSF; setting to null: " << err.what());
    }
    try {
        result->setCoaddInputs(readCoaddInputs());
    } catch (pex::exceptions::NotFoundError& err) {
        LOGLS_WARN(_log, "Could not read CoaddInputs; setting to null: " << err.what());
    }
    try {
        result->setApCorrMap(readApCorrMap());
    } catch (pex::exceptions::NotFoundError& err) {
        LOGLS_WARN(_log, "Could not read ApCorrMap; setting to null: " << err.what());
    }
    try {
        result->setValidPolygon(readValidPolygon());
    } catch (pex::exceptions::NotFoundError& err) {
        LOGLS_WARN(_log, "Could not read ValidPolygon; setting to null: " << err.what());
    }
    try {
        result->setTransmissionCurve(readTransmissionCurve());
    } catch (pex::exceptions::NotFoundError& err) {
        LOGLS_WARN(_log, "Could not read TransmissionCurve; setting to null: " << err.what());
    }
    try {
        result->setDetector(readDetector());
    } catch (pex::exceptions::NotFoundError& err) {
        LOGLS_WARN(_log, "Could not read Detector; setting to null: " << err.what());
    }
    // In the case of WCS, we fall back to the metadata WCS if the one from
    // the archive can't be read.
    _ensureReaders();
    result->setWcs(_metadataReader->wcs);
    try {
        auto wcs = _archiveReader->readComponent<afw::geom::SkyWcs>(_getFitsFile(), ArchiveReader::WCS);
        if (!wcs) {
            LOGLS_DEBUG(_log, "No WCS found in binary table");
        } else {
            result->setWcs(wcs);
        }
    } catch (pex::exceptions::NotFoundError& err) {
        auto msg = str(boost::format("Could not read WCS extension; setting to null: %s") % err.what());
        if (result->hasWcs()) {
            msg += " ; using WCS from FITS header";
        }
        LOGLS_WARN(_log, msg);
    }
    for (const auto& keyValue : readExtraComponents()) {
        using StorablePtr = std::shared_ptr<typehandling::Storable const>;
        std::string key = keyValue.first;
        StorablePtr object = std::dynamic_pointer_cast<StorablePtr::element_type>(keyValue.second);
 
        if (object.use_count() > 0) {  // Failed cast guarantees empty pointer, but not a null one
            result->setComponent(typehandling::makeKey<StorablePtr>(key), object);
        } else {
            LOGLS_WARN(_log, "Data corruption: generic component " << key << " is not a Storable; skipping.");
        }
    }
    // Convert old-style Filter to new-style FilterLabel
    // In newer versions this is handled by readExtraComponents()
    if (_metadataReader->version < 2 && !result->hasFilter()) {
        result->setFilter(readFilter());
    }
    return result;
}  // namespace image

readExtraComponents()

std::map< std::string, std::shared_ptr< table::io::Persistable > > lsst::afw::image::ExposureFitsReader::readExtraComponents

(

)

Read the Exposure's non-standard components.

Definition at line 493 of file ExposureFitsReader.cc.

                                                                                             {
    _ensureReaders();
    return _archiveReader->readExtraComponents(_getFitsFile());
}

readFilter()

std::shared_ptr< FilterLabel > lsst::afw::image::ExposureFitsReader::readFilter

(

)

Read the Exposure's filter information.

Definition at line 433 of file ExposureFitsReader.cc.

                                                          {
    _ensureReaders();
    if (_metadataReader->version < 2) {
        return _metadataReader->filterLabel;
    } else {
        return _archiveReader->readComponent<FilterLabel>(_getFitsFile(), ExposureInfo::KEY_FILTER.getId());
    }
}

readImage()

template<typename ImagePixelT >

template Image< std::uint64_t > lsst::afw::image::ExposureFitsReader::readImage	(	lsst::geom::Box2I const &	bbox = lsst::geom::Box2I(),
		ImageOrigin	origin = PARENT,
		bool	allowUnsafe = false )

Read the image plane.

Parameters

bbox	A bounding box used to defined a subimage, or an empty box (default) to read the whole image.
origin	Coordinate system convention for the given box.
allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

In Python, this templated method is wrapped with an additional dtype argument to provide the type to read. This defaults to the type of the on-disk image.

Definition at line 580 of file ExposureFitsReader.cc.

                                                                   {
    return _maskedImageReader.readImage<ImagePixelT>(bbox, origin, allowUnsafe);
}

readImageArray()

template<typename ImagePixelT >

template ndarray::Array< std::uint64_t, 2, 2 > lsst::afw::image::ExposureFitsReader::readImageArray	(	lsst::geom::Box2I const &	bbox = lsst::geom::Box2I(),
		ImageOrigin	origin = PARENT,
		bool	allowUnsafe = false )

Read the image plane.

Parameters

bbox	A bounding box used to defined a subimage, or an empty box (default) to read the whole image.
origin	Coordinate system convention for the given box.
allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

In Python, this templated method is wrapped with an additional dtype argument to provide the type to read. This defaults to the type of the on-disk image.

Definition at line 586 of file ExposureFitsReader.cc.

                                                                                                           {
    return _maskedImageReader.readImageArray<ImagePixelT>(bbox, origin, allowUnsafe);
}

readImageDType()

std::string lsst::afw::image::ExposureFitsReader::readImageDType

(

)

const

Read a string describing the pixel type of the on-disk image plane.

Returns

A string of the form [u](int|float)<bits> (e.g. "uint16", "float64").

Definition at line 408 of file ExposureFitsReader.cc.

{ return _maskedImageReader.readImageDType(); }

readMask()

template<typename MaskPixelT >

template Mask< MaskPixel > lsst::afw::image::ExposureFitsReader::readMask	(	lsst::geom::Box2I const &	bbox = lsst::geom::Box2I(),
		ImageOrigin	origin = PARENT,
		bool	conformMasks = false,
		bool	allowUnsafe = false )

Read the mask plane.

Parameters

bbox	A bounding box used to defined a subimage, or an empty box (default) to read the whole image.
origin	Coordinate system convention for the given box.
conformMasks	If True, conform the global mask dict to match this file.
allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

In Python, this templated method is wrapped with an additional dtype argument to provide the type to read. This defaults to the type of the on-disk image.

Definition at line 592 of file ExposureFitsReader.cc.

                                                                                   {
    return _maskedImageReader.readMask<MaskPixelT>(bbox, origin, conformMasks, allowUnsafe);
}

readMaskArray()

template<typename MaskPixelT >

template ndarray::Array< MaskPixel, 2, 2 > lsst::afw::image::ExposureFitsReader::readMaskArray	(	lsst::geom::Box2I const &	bbox = lsst::geom::Box2I(),
		ImageOrigin	origin = PARENT,
		bool	allowUnsafe = false )

Read the mask plane.

Parameters

bbox	A bounding box used to defined a subimage, or an empty box (default) to read the whole image.
origin	Coordinate system convention for the given box.
allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

In Python, this templated method is wrapped with an additional dtype argument to provide the type to read. This defaults to the type of the on-disk image.

Definition at line 598 of file ExposureFitsReader.cc.

                                                                                                         {
    return _maskedImageReader.readMaskArray<MaskPixelT>(bbox, origin, allowUnsafe);
}

readMaskDType()

std::string lsst::afw::image::ExposureFitsReader::readMaskDType

(

)

const

Read a string describing the pixel type of the on-disk image plane.

Returns

A string of the form [u](int|float)<bits> (e.g. "uint16", "float64").

Definition at line 410 of file ExposureFitsReader.cc.

{ return _maskedImageReader.readMaskDType(); }

readMaskedImage()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >

template MaskedImage< std::uint64_t, MaskPixel, VariancePixel > lsst::afw::image::ExposureFitsReader::readMaskedImage	(	lsst::geom::Box2I const &	bbox = lsst::geom::Box2I(),
		ImageOrigin	origin = PARENT,
		bool	conformMasks = false,
		bool	allowUnsafe = false )

Read the MaskedImage.

Parameters

bbox	A bounding box used to defined a subimage, or an empty box (default) to read the whole image.
origin	Coordinate system convention for the given box.
conformMasks	If True, conform the global mask dict to match this file.
allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

In Python, this templated method is wrapped with an additional dtype argument to provide the type to read (for the image plane). This defaults to the type of the on-disk image.

Definition at line 617 of file ExposureFitsReader.cc.

                                                                                            {
    return _maskedImageReader.read<ImagePixelT, MaskPixelT, VariancePixelT>(bbox, origin, conformMasks,
                                                                            /* needAllHdus= */ false,
                                                                            allowUnsafe);
}

readMetadata()

std::shared_ptr< daf::base::PropertyList > lsst::afw::image::ExposureFitsReader::readMetadata

(

)

Read the flexible metadata associated with the Exposure.

FITS header keys used to construct other Exposure components will be stripped.

Definition at line 414 of file ExposureFitsReader.cc.

                                                                    {
    _ensureReaders();
    return _metadataReader->metadata;
}

readPhotoCalib()

std::shared_ptr< PhotoCalib > lsst::afw::image::ExposureFitsReader::readPhotoCalib

(

)

Read the Exposure's photometric calibration.

Definition at line 442 of file ExposureFitsReader.cc.

                                                             {
    _ensureReaders();
    if (_metadataReader->version == 0) {
        return _metadataReader->photoCalib;
    } else {
        return _archiveReader->readComponent<image::PhotoCalib>(_getFitsFile(), ArchiveReader::PHOTOCALIB);
    }
}

readPsf()

std::shared_ptr< detection::Psf > lsst::afw::image::ExposureFitsReader::readPsf

(

)

Read the Exposure's point-spread function.

Definition at line 451 of file ExposureFitsReader.cc.

                                                        {
    _ensureReaders();
    return _archiveReader->readComponent<detection::Psf>(_getFitsFile(), ArchiveReader::PSF);
}

readSerializationVersion()

int lsst::afw::image::ExposureFitsReader::readSerializationVersion

(

)

Read the serialization version number from the header.

Definition at line 403 of file ExposureFitsReader.cc.

                                                 {
    _ensureReaders();
    return _metadataReader->version;
}

readTransmissionCurve()

std::shared_ptr< TransmissionCurve > lsst::afw::image::ExposureFitsReader::readTransmissionCurve

(

)

Read the Exposure's transmission curve.

Definition at line 477 of file ExposureFitsReader.cc.

                                                                           {
    _ensureReaders();
    return _archiveReader->readComponent<TransmissionCurve>(_getFitsFile(),
                                                            ArchiveReader::TRANSMISSION_CURVE);
}

readValidPolygon()

std::shared_ptr< afw::geom::polygon::Polygon > lsst::afw::image::ExposureFitsReader::readValidPolygon

(

)

Read the polygon describing the region of validity for the Exposure.

Definition at line 456 of file ExposureFitsReader.cc.

                                                                          {
    _ensureReaders();
    return _archiveReader->readComponent<afw::geom::polygon::Polygon>(_getFitsFile(),
                                                                      ArchiveReader::VALID_POLYGON);
}

readVariance()

template<typename VariancePixelT >

template Image< VariancePixel > lsst::afw::image::ExposureFitsReader::readVariance	(	lsst::geom::Box2I const &	bbox = lsst::geom::Box2I(),
		ImageOrigin	origin = PARENT,
		bool	allowUnsafe = false )

Read the variance plane.

Parameters

bbox	A bounding box used to defined a subimage, or an empty box (default) to read the whole image.
origin	Coordinate system convention for the given box.
allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

In Python, this templated method is wrapped with an additional dtype argument to provide the type to read. This defaults to the type of the on-disk image.

Definition at line 604 of file ExposureFitsReader.cc.

                                                                         {
    return _maskedImageReader.readVariance<VariancePixelT>(bbox, origin, allowUnsafe);
}

readVarianceArray()

template<typename VariancePixelT >

template ndarray::Array< VariancePixel, 2, 2 > lsst::afw::image::ExposureFitsReader::readVarianceArray	(	lsst::geom::Box2I const &	bbox = lsst::geom::Box2I(),
		ImageOrigin	origin = PARENT,
		bool	allowUnsafe = false )

Read the variance plane.

Parameters

bbox	A bounding box used to defined a subimage, or an empty box (default) to read the whole image.
origin	Coordinate system convention for the given box.
allowUnsafe	Permit reading into the requested pixel type even when on-disk values may overflow or truncate.

In Python, this templated method is wrapped with an additional dtype argument to provide the type to read. This defaults to the type of the on-disk image.

Definition at line 610 of file ExposureFitsReader.cc.

                                                                                             {
    return _maskedImageReader.readVarianceArray<VariancePixelT>(bbox, origin, allowUnsafe);
}

readVarianceDType()

std::string lsst::afw::image::ExposureFitsReader::readVarianceDType

(

)

const

Read a string describing the pixel type of the on-disk image plane.

Returns

A string of the form [u](int|float)<bits> (e.g. "uint16", "float64").

Definition at line 412 of file ExposureFitsReader.cc.

{ return _maskedImageReader.readVarianceDType(); }

readVisitInfo()

std::shared_ptr< VisitInfo > lsst::afw::image::ExposureFitsReader::readVisitInfo

(

)

Read the Exposure's visit metadata.

Definition at line 472 of file ExposureFitsReader.cc.

                                                           {
    _ensureReaders();
    return _metadataReader->visitInfo;
}

readWcs()

std::shared_ptr< afw::geom::SkyWcs > lsst::afw::image::ExposureFitsReader::readWcs

(

)

Read the Exposure's world coordinate system.

Definition at line 424 of file ExposureFitsReader.cc.

                                                         {
    _ensureReaders();
    auto r = _archiveReader->readComponent<afw::geom::SkyWcs>(_getFitsFile(), ArchiveReader::WCS);
    if (!r) {
        r = _metadataReader->wcs;
    }
    return r;
}

readXY0()

lsst::geom::Point2I lsst::afw::image::ExposureFitsReader::readXY0	(	lsst::geom::Box2I const &	bbox = lsst::geom::Box2I(),
		ImageOrigin	origin = PARENT )

Read the image origin from the on-disk image or a subimage thereof.

Parameters

bbox	A bounding box used to defined a subimage, or an empty
origin	Coordinate system convention for the given box. Ignored if bbox is empty.

Definition at line 399 of file ExposureFitsReader.cc.

                                                                                         {
    return _maskedImageReader.readXY0(bbox, origin);
}

---

The documentation for this class was generated from the following files:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/g95236ca021+d4f98599f0/include/lsst/afw/image/ExposureFitsReader.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/g95236ca021+d4f98599f0/src/image/ExposureFitsReader.cc