SourceXtractorPlusPlus  0.12
Please provide a description of the project.
Public Member Functions | Private Attributes | List of all members
sourcextractor.config.argv.FileList Class Reference
Inheritance diagram for sourcextractor.config.argv.FileList:
[legend]
Collaboration diagram for sourcextractor.config.argv.FileList:
[legend]

Public Member Functions

def __init__ (self, value)
 
def __iter__ (self)
 
def __len__ (self)
 
def __str__ (self)
 
def __repr__ (self)
 

Private Attributes

 __files
 

Detailed Description

Helper class for receiving a globing pattern as a parameter, defining a list of files
- i.e. measurement images or PSFs.
It is an iterable, and can be passed directly to load_fits_images.

Parameters
----------
value : str
    A file globing expression. i.e "*.psf", "band_[r|i|g]_*.fits" or similar.
    The result is always stored and returned in alphabetical order, so the order between two
    file lists - i.e frame image and PSF - is consistent and a matching can be done easily between them.

See Also
--------
    glob.glob : Return a list of paths matching a pathname pattern.

Definition at line 128 of file argv.py.

Constructor & Destructor Documentation

◆ __init__()

def sourcextractor.config.argv.FileList.__init__ (   self,
  value 
)
Constructor.

Definition at line 146 of file argv.py.

Member Function Documentation

◆ __iter__()

def sourcextractor.config.argv.FileList.__iter__ (   self)
Returns
-------
    iterator

Definition at line 152 of file argv.py.

References sourcextractor.config.argv.FileList.__files.

◆ __len__()

def sourcextractor.config.argv.FileList.__len__ (   self)
Returns
-------
int
    Length of the list

Definition at line 160 of file argv.py.

References sourcextractor.config.argv.FileList.__files.

◆ __repr__()

def sourcextractor.config.argv.FileList.__repr__ (   self)
Returns
-------
str
    String representation for the object

Definition at line 178 of file argv.py.

References sourcextractor.config.argv.FileList.__files.

◆ __str__()

def sourcextractor.config.argv.FileList.__str__ (   self)
Returns
-------
str
    Human readable representation for the object

Definition at line 169 of file argv.py.

References sourcextractor.config.argv.FileList.__files.

Member Data Documentation

◆ __files

sourcextractor.config.argv.FileList.__files
private

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