Dolphot

class delphinus.delphinus.Dolphot(workDir, **params)

Bases: object

The Dolphot class manages a single run of dolphot itself.

This class manages dolphot parameters, runs dolphot, and provides paths to the dolphot output, including the ability to compile the dolphot photometry tables into a Pythonic data structure.

Parameters :

workDir : str

Work directory for photometry

**params : kwargs

Parameters general to a run of Dolphot. Image-specific parameters are passed with the add_image() and add_reference() methods.

Attributes

Methods Summary

add_image(imagePath[, key, band])	Add an image to the set to be photometered.
add_reference(imagePath, **params)	Add an image to the set to be photometered.
change_param(key, param)	Change or add a single parameter.
compile_hdf5([tablePath])	Make an HDF5 file of the photometric output.
label_fake_output(label)	Renames artificial star test output (useful it running multiple fake star lists on the same photometry).
run(outputName[, clean])	Run dolphot photometry given the parameter settings.
run_ast(outputName, starListName)	Run dolphot photometry in artificial star test mode.
write_parameters(outputName[, fullPath])	Write parameters to a .params file for DOLPHOT.

Methods Documentation

add_image(imagePath, key=None, band=None, **params)

Add an image to the set to be photometered.

Parameters :

imagePath : str

Full path to the FITS file to be photomered. MEF or single extension fits are valid.

key : str

String that uniquely identifies an image in your pipeline. The key is used in the HDF5 photometry table to show the order of images. Set to the file name, without directory and extension if left as None.

band : str

Band-pass of this image. Can be used to help create cursory CMDs. If not set, the bandpass of each image is labeled 'None'.

**params : kwargs

Parameters to be passed for this image. See parameter listing of DolphotParameters.setup_image().

add_reference(imagePath, **params)

Add an image to the set to be photometered.

Parameters :

imagePath : str

Full path to the FITS file to be photomered. MEF or single extension fits are valid.

**params : dict

Parameters to be passed for this image. See parameter listing of DolphotParameters.setup_image().

change_param(key, param)

Change or add a single parameter. These must be general parameters.

compile_hdf5(tablePath=None)

Make an HDF5 file of the photometric output.

label_fake_output(label)

Renames artificial star test output (useful it running multiple fake star lists on the same photometry).

run(outputName, clean=True)

Run dolphot photometry given the parameter settings.

run_ast(outputName, starListName)

Run dolphot photometry in artificial star test mode.

This method differs from run() in that it will create a directory to perform the AST in, so that multiple star lists can be simultaneously run on a single input photometry. That is, this method prevents the AST output of one star list from clobbering that of another.

Note

This method may be deprecated.

write_parameters(outputName, fullPath=False)

Write parameters to a .params file for DOLPHOT. This method is automatically called by run().