Stamps

class lsst.meas.algorithms.Stamps(stamps, metadata=None, use_mask=True, use_variance=True, use_archive=False)

Bases: StampsBase

Attributes Summary

metadata

Methods Summary

append(item)

Add an additional stamp.

count(value)

extend(stamp_list)

Extend Stamps instance by appending elements from another instance.

getArchiveElements()

Retrieve archive elements associated with each stamp.

getMaskedImages()

Retrieve star images.

getPositions()

index(value, [start, [stop]])

Raises ValueError if the value is not present.

readFits(filename)

Build an instance of this class from a file.

readFitsWithOptions(filename, options)

Build an instance of this class with options.

writeFits(filename)

Write this object to a file.

Attributes Documentation

metadata

Methods Documentation

append(item)

Add an additional stamp.

Parameters:
itemStamp

Stamp object to append.

count(value) integer -- return number of occurrences of value
extend(stamp_list)

Extend Stamps instance by appending elements from another instance.

Parameters:
stamps_listlist [Stamp]

List of Stamp object to append.

getArchiveElements()

Retrieve archive elements associated with each stamp.

Returns:
archiveElements

list [lsst.afwTable.io.Persistable]

getMaskedImages()

Retrieve star images.

Returns:
maskedImages

list [lsst.afw.image.maskedImage.maskedImage.MaskedImageF]

getPositions()
index(value[, start[, stop]]) integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

classmethod readFits(filename)

Build an instance of this class from a file.

Parameters:
filenamestr

Name of the file to read

Returns:
objectStamps

An instance of this class

classmethod readFitsWithOptions(filename, options)

Build an instance of this class with options.

Parameters:
filenamestr

Name of the file to read

optionsPropertyList or dict

Collection of metadata parameters

Returns:
objectStamps

An instance of this class

writeFits(filename)

Write this object to a file.

Parameters:
filenamestr

Name of file to write