pysilcam.silcreport module

pysilcam.silcreport.silcam_report(statsfile, configfile, particle_type=<outputPartType.all: 1>, particle_type_str='all', monitor=False, dpi=600, crop_stats=None)

does reporting

pysilcam.silcreport.silcreport()

Generate a report figure for a processed dataset from the SilCam.

You can access this function from the command line using the below documentation.

Usage:

silcam-report <configfile> <statsfile> [–type=<particle_type>]

[–dpi=<dpi>] [–monitor] [–filter-stats=<y1,x1,y2,x2>]

Parameters

• configfile – The config filename associated with the data

• statsfile – The -STATS.h5 filename associated with the data

Options:

--type=<particle_type>

The particle type to summarise. Can be: ‘all’, ‘oil’, or ‘gas’

--dpi=<dpi>

DPI resolution of figure (default is 600)

--monitor

Enables continuous monitoring (requires display)

–filter-stats=<y1,x1,y2,x2> Filters stats file to only include particle

from the specified coordinate rectangle. (y1,x1) are the lower-left corner, and (y2,x2) are the upper-right corner of the rectangle.

-h –help Show this screen.