PyPlate API

metadata module

class pyplate.metadata.Archive

Bases: object

Plate archive metadata class.

assign_conf(conf)

Assign and parse configuration.

get_logbooklist()

Get list of logbook identifications

get_logbookmeta(num=None)

Get metadata for the specific logbook.

get_logpagelist()

Get list of logpage filenames

get_logpagemeta(filename=None)

Get metadata for the specific logpage.

get_platelist()

Get list of plate IDs based on WFPDB and CSV files

get_platemeta(plate_id=None, wfpdb_id=None, filename=None)

Get metadata for the specific plate (or scan).

Source files are parsed in the following order: WFPDB maindata, WFPDB quality, WFPDB observer, WFPDB notes, plate CSV, scan CSV, configuration file.

Parameters:

• plate_id (str) – Plate ID used in metadata files.
• filename (str) – Name of the plate scan file.

Returns:

platemeta – Plate object that contains the plate metadata.

Return type:

a Plate object

get_previewlist()

Get list of preview files

get_previewmeta(filename=None)

Get metadata for the specific preview image.

get_scanlist()

Get list of filenames from CSV files

output_logpages_db()

Write logpages to the database.

output_plates_db()

Write plates to the database.

output_previews_db()

Write previews to the database.

output_scans_db()

Write scans to the database.

read_csv(csv_dir=None, fn_plate_csv=None, fn_scan_csv=None, fn_preview_csv=None, fn_logbook_csv=None, fn_logpage_csv=None)

Read CSV files.

Parameters:

• csv_dir (str) – Path to the directory with CSV files.
• fn_plate_csv (str) – Name of the plate metadata CSV file.
• fn_scan_csv (str) – Name of the scan metadata CSV file.
• fn_preview_csv (str) – Name of the preview metadata CSV file.
• fn_logbook_csv (str) – Name of the logbook CSV file.
• fn_logpage_csv (str) – Name of the logpage CSV file.

read_wfpdb(wfpdb_dir=None, fn_maindata=None, fn_quality=None, fn_notes=None, fn_observer=None)

Read WFPDB data files.

Parameters:

• wfpdb_dir (str) – Path to the directory with WFPDB files.
• fn_maindata (str) – Name of the WFPDB maindata file.
• fn_quality (str) – Name of the WFPDB quality file.
• fn_notes (str) – Name of the WFPDB notes file.
• fn_observer (str) – Name of the WFPDB observer file.

class pyplate.metadata.ArchiveMeta

Bases: pyplate.metadata.Archive

class pyplate.metadata.CSV_Dict(*args, **kwargs)

Bases: collections.OrderedDict

Metadata CSV dictionary class.

class pyplate.metadata.Logbook(*args, **kwargs)

Bases: collections.OrderedDict

Logbook metadata class.

assign_conf(conf)

Assign configuration.

parse_csv(val_list, csv_filename=None)

Extract data from a CSV row.

class pyplate.metadata.LogbookMeta(*args, **kwargs)

Bases: pyplate.metadata.Logbook

class pyplate.metadata.Logpage(*args, **kwargs)

Bases: collections.OrderedDict

Logpage metadata class.

assign_conf(conf)

Assign configuration.

parse_csv(val_list, csv_filename=None)

Extract data from a CSV row.

parse_exif()

Extract data from image EXIF.

class pyplate.metadata.LogpageMeta(*args, **kwargs)

Bases: pyplate.metadata.Logpage

class pyplate.metadata.Plate(*args, **kwargs)

Bases: collections.OrderedDict

Plate metadata class.

assign_conf(conf)

Assign configuration.

calculate()

Compute UT time from sidereal time and precess coordinates from plate epoch to J2000.

compute_values()

Compute UT time from sidereal time and precess coordinates from plate epoch to J2000.

copy() → a shallow copy of od

get_value(key, exp=0)

Get Plate value for SQL query

Parameters:key (str) – Plate keyword to be fetched Returns:Plate value corresponding to the keyword Return type:val

parse_conf()

Extract data from configuration file.

parse_csv(val_list, csv_filename=None)

Extract data from a CSV row.

parse_header(header)

Extract data from FITS header.

parse_maindata(maindata_entry)

Extract data from the WFPDB maindata entry.

parse_notes(notes_entry)

Extract data from the WFPDB notes entry.

parse_observer(observer_entry)

Extract data from the WFPDB observer entry.

parse_quality(quality_entry)

Extract data from the WFPDB quality entry.

printdata()

Print keywords and their values.

class pyplate.metadata.PlateHeader(*args, **kwargs)

Bases: astropy.io.fits.header.Header

Plate header class. Based on FITS header class from astropy.io.

assign_conf(conf)

Assign configuration to the plate header.

assign_platemeta(platemeta)

Assign plate metadata.

assign_values()

Assign fixed keyword values (integers, floats and strings separately).

compute_values()

Compute keyword values.

format()

Format and reorder header cards.

classmethod from_fits(filename)

Read header from FITS file.

classmethod from_hdrf(filename)

Read header from the output file of header2011.

insert_wcs(wcshead)

Insert WCS header cards.

output_to_file(filename)

Output header to a text file.

output_to_fits(filename, checksum=None)

Output header to FITS file.

populate()

Populate header with blank cards.

rename_keywords()

Rename keywords in the header.

reorder()

Reorder header cards based on configuration.

rewrite()

Rewrite header cards with proper formatting.

update_all()

Do all header updates.

update_comments()

Add/modify keyword comments based on configuration.

update_from_fits(filename)

Update header with header values in a FITS file.

update_from_platemeta(platemeta=None)

Update header with plate metadata.

update_values()

Edit keyword values based on configuration.

class pyplate.metadata.PlateMeta(*args, **kwargs)

Bases: pyplate.metadata.Plate

class pyplate.metadata.Preview(*args, **kwargs)

Bases: collections.OrderedDict

Preview image metadata class.

assign_conf(conf)

Assign configuration.

parse_csv(val_list, csv_filename=None)

Extract data from a CSV row.

parse_exif()

Extract data from image EXIF.

class pyplate.metadata.PreviewMeta(*args, **kwargs)

Bases: pyplate.metadata.Preview

pyplate.metadata.str_to_num(s)

Convert string to int or float, if possible. Otherwise return the original string.

solve module

class pyplate.solve.AstrometryNetIndex(*args)

Bases: object

Astrometry.net index class

create_index_loop(start_year, end_year, step, max_scale=None, min_scale=None, sort_by='BTmag')

Create Astrometry.net indexes for a set of epochs.

create_index_year(year, max_scale=None, min_scale=None, sort_by='BTmag')

Create Astrometry.net index for a given epoch.

download_tycho2(site=None)

Download full Tycho-2 catalogue with vizquery.

Parameters:site (str) – A site name that vizquery recognizes

class pyplate.solve.SolveProcess(filename, archive_id=None)

Bases: object

Plate solve process class

assign_conf(conf)

Parse configuration and set class attributes.

assign_header(header)

Assign FITS header with metadata.

assign_metadata(platemeta)

Assign plate metadata.

calibrate_photometry()

Calibrate extracted magnitudes.

db_process_end(completed=None)

Write process end to the database.

Parameters:completed (int) – A boolean value specifying whether the process was completed

db_process_start()

Write process start to the database.

db_update_process(**kwargs)

Update process in the database.

Parameters:

• num_sources (int) – Number of extracted sources
• solved (int) – A boolean value specifying whether plate was solved successfully with Astrometry.net

extract_sources(threshold_sigma=None, use_filter=None, filter_path=None, use_psf=None, psf_threshold_sigma=None, psf_model_sigma=None, circular_film=None)

Extract sources from a FITS file.

Parameters:

• threshold_sigma (float) – SExtractor threshold in sigmas (default 4.0)
• use_filter (bool) – Use SExtractor filter for source detection (default False)
• filter_path (string) – Path to SExtractor filter file
• use_psf (bool) – Use PSF for bright stars (default False)
• psf_threshold_sigma (float) – SExtractor threshold in sigmas for using PSF (default 20.0)
• psf_model_sigma (float) – SExtractor threshold in sigmas for PSF model stars (default 20.0)
• circular_film (bool) – Assume circular film (default False)

finish()

Finish plate process.

get_reference_catalogs()

Get reference catalogs for astrometric and photometric calibration.

improve_photometry_recursive(max_recursion_depth=None)

Improve photometric calibration recursively in sub-fields.

invert_plate()

Invert FITS image and save the result (*_inverted.fits) in the scratch or work directory.

output_astrom_sub_db()

Write astrometric sub-field calibration to the database.

output_calibration_db()

Write photometric calibration to the database.

output_color_db()

Write photometric color term result to the database.

output_cterm_db()

Write photometric color term data to the database.

output_solution_db()

Write plate solution to the database.

output_sources_csv(filename=None)

Write extracted sources to a CSV file.

output_sources_db(write_csv=None)

Write extracted sources to the database.

output_wcs_header()

Write WCS header to an ASCII file.

process_source_coordinates()

Combine coordinates from the global and recursive solutions. Calculate X, Y, and Z on the unit sphere.

setup()

Set up plate solve process.

solve_plate(plate_epoch=None, sip=None, skip_bright=None)

Solve astrometry in a FITS file.

Parameters:

• plate_epoch (float) – Epoch of plate in decimal years (default 1950.0)
• sip (int) – SIP distortion order (default 3)
• skip_bright (int) – Number of brightest stars to skip when solving with Astrometry.net (default 10).

solve_recursive(plate_epoch=None, distort=None, skip_bright=None, max_recursion_depth=None, force_recursion_depth=None)

Solve astrometry in a FITS file.

Parameters:

• plate_epoch (float) – Epoch of plate in decimal years (default 1950.0)
• distort (int) – SCAMP distortion order (default 1)
• skip_bright (int) – Number of brightest stars to skip when solving with Astrometry.net (default 10).
• max_recursion_depth (int) – Maximum recursion depth (default 5)
• force_recursion_depth (int) – Force recursion depth if enough stars (default 0)

class pyplate.solve.SolveProcessLog(file_path)

Bases: object

Plate solve process log class

close()

Close log file.

open()

Open log file.

to_db(level, message, event=None)

Write a log message to the database.

Parameters:

• level (int) – Log level (1 = error, 2 = warning, 3 = info, 4 = debug, 5 = trace)
• message (str) – Message to be written to the log file
• event (int) – Event code (default None)

write(message, timestamp=True, double_newline=True, level=None, event=None)

Write a message to the log file and optionally to the database.

Parameters:

• message (str) – Message to be written to the log file
• timestamp (bool) – Write timestamp with the message (default True)
• double_newline (bool) – Add two newline characters after the message (default True)

pyplate.solve.new_scampref()

Create HDUList for SCAMP reference catalogue.

Returns:hdulist Return type:an astropy.io.fits.HDUList object

database module

class pyplate.database.PlateDB

Bases: object

Plate database class.

assign_conf(conf)

Assign and parse configuration.

close_connection()

Close MySQL database connection.

execute_query(*args)

Execute SQL query and reopen connection if connection has been lost.

executemany_query(*args)

Execute SQL query with mutliple data rows and reopen connection if connection has been lost.

get_logbook_id(logbook_num, archive_id)

Get logbook ID from the database by archive ID and logbook number.

Parameters:

• logbook_num (str) – Logbook number (unique within the specified archive)
• archive_id (int) – Archive ID

Returns:

logbook_id – Logbook ID

Return type:

int

get_logpage_id(filename, archive_id)

Get logpage ID from the database.

Parameters:

• filename (str) – Filename of the logpage
• archive_id (int) – Archive ID number

Returns:

result – Logpage ID number

Return type:

int

get_plate_epoch(plate_id)

Get plate epoch from the database.

Parameters:plate_id (int) – Plate ID number Returns:result – Plate epoch as a float Return type:float

get_plate_id(plate_num, archive_id)

Get plate ID from the database by archive ID and plate number.

Parameters:

• plate_num (str) – Plate number
• archive_id (int) – Archive ID

Returns:

plate_id – Plate ID

Return type:

int

get_plate_id_wfpdb(wfpdb_id)

Get plate ID from the database by WFPDB ID.

Parameters:wfpdb_id (str) – WFPDB ID Returns:plate_id – Plate ID Return type:int

get_scan_id(filename, archive_id)

Get scan ID and plate ID from the database.

Parameters:

• filename (str) – Filename of the scan
• archive_id (int) – Archive ID number

Returns:

result – A tuple containing scan ID and plate ID

Return type:

tuple

open_connection(host=None, user=None, passwd=None, dbname=None)

Open MySQL database connection.

Parameters:

• host (str) – MySQL database host name
• user (str) – MySQL database user name
• passwd (str) – MySQL database password
• dbname (str) – MySQL database name

update_process(process_id, **kwargs)

Update plate-solve process in the database.

update_scan(platemeta, filecols=False)

Update scan entry in the database.

Parameters:

• platemeta (Plate) – Plate metadata instance
• filecols (bool) – If True, only specific file-related columns are updated

write_astrom_sub(astrom_sub, process_id=None, scan_id=None, plate_id=None, archive_id=None)

Write astrometric sub-field calibration to the database.

write_logbook(logbookmeta)

Write a logbook to the database.

write_logpage(logpagemeta)

Write a single logpage to the database.

write_phot_calib(phot_calib, process_id=None, scan_id=None, plate_id=None, archive_id=None)

Write photometric calibration to the database.

write_phot_color(phot_color, process_id=None, scan_id=None, plate_id=None, archive_id=None)

Write photometric color term result to the database.

write_phot_cterm(phot_cterm, process_id=None, scan_id=None, plate_id=None, archive_id=None)

Write photometric color term data to the database.

write_phot_sub(phot_sub, process_id=None, scan_id=None, plate_id=None, archive_id=None)

Write photometric sub-field calibration to the database.

write_plate(platemeta)

Write plate entry to the database.

Parameters:platemeta (Plate) – Plate metadata instance Returns:plate_id – Plate ID number Return type:int

write_plate_logpage(platemeta)

Write plate-logpage relations to the database.

Parameters:platemeta (Plate) – Plate metadata instance

write_preview(previewmeta)

Write preview image entry to the database.

Parameters:previewmeta (Preview) – Preview metadata instance Returns:preview_id – Preview ID number Return type:int

write_process_end(process_id, completed=None, duration=None)

Write plate-solve process end to the database.

write_process_start(scan_id=None, plate_id=None, archive_id=None, filename=None, use_psf=None)

Write plate-solve process to the database.

write_processlog(level, message, event=None, process_id=None, scan_id=None, plate_id=None, archive_id=None)

Write plate solve process log message to the database.

write_scan(platemeta)

Write scan entry to the database.

Parameters:platemeta (Plate) – Plate metadata instance Returns:scan_id – Scan ID number Return type:int

write_solution(solution, process_id=None, scan_id=None, plate_id=None, archive_id=None)

Write plate solution to the database.

write_sources(sources, process_id=None, scan_id=None, plate_id=None, archive_id=None, write_csv=None)

Write source data to the database.

class pyplate.database.csvWriter(csvfile, *args, **kwrags)

Bases: object

writerow(row)

writerows(rows)

pyplate.database.print_tables(use_drop=False, engine='Aria')

Print table creation SQL queries to standard output.

image module

class pyplate.image.PlateConverter

Bases: object

TIFF-to-FITS converter class

assign_conf(conf)

Parse configuration and set class attributes.

batch_tiff2fits()

Convert all TIFF images in the TIFF directory to FITS.

tiff2fits(filename, cut_wedge=None, wedge_height=None)

Convert TIFF image to FITS.

Parameters:

• filename (str) – Filename of the TIFF image
• cut_wedge (bool) – If True, a wedge image is separated from below plate image
• wedge_height (int) – Height of the wedge in pixels

pipeline module

class pyplate.pipeline.PlateImagePipeline(plate_converter=None)

Bases: pyplate.pipeline.PlatePipeline

class pyplate.pipeline.PlatePipeline(plate_converter=None)

Bases: object

Plate processing pipeline class

assign_conf(conf)

Parse configuration and set class attributes.

parallel_run(filenames, processes=None, process_max_tasks=None, wait_start=None)

Run plate image processes in parallel.

Parameters:

• filenames (list) – List of filenames to process
• processes (int) – Number of parallel processes
• process_max_tasks (int) – Number of images processed after which the worker process is renewed
• wait_start (float) – Number of seconds to wait before starting another worker process at the beginning

single_image(filename, plate_epoch=None)

Process single plate image.

Parameters:

• filename (str) – Filename of the FITS image to be processed
• plate_epoch (float) – Plate epoch (decimal year)

worker()

Take a filename from the queue and process the file.

conf module

pyplate.conf.read_conf(conf_file)

Read configuration file.

Parameters:conf_file (str) – Configuration file path. Returns:conf Return type:a ConfigParser object