Skip to content

The configuration file

Jump to bottom
Chiara Marmo edited this page May 13, 2016 · 15 revisions

The file configuration.cfg is mainly made for the mode 3 of FreeTure (meteor detection mode).

##INPUT DEVICE

  • CAMERA_ID If there are several available cameras, this parameter can be used to select the wanted device. The device ID can be known by running freeture -l option. If videos or frames directories are wished in input, the values VIDEOFILE or FRAMESDIR can be used.

  • INPUT_VIDEO_PATH If CAMERA_ID 's value is VIDEOFILE, path of videos can be defined here separated by a comma.

  • INPUT_FRAMES_DIRECTORY_PATH If CAMERA_ID is FRAMESDIR, path of fits frames directories can be defined here separated by a comma.

  • INPUT_TIME_INTERVAL This value in milliseconds indicates the time between two video's frames or the loading of two fits frames. It is used to slow down the acquisition in order to give more time to the detection process.

##ACQUISITION PARAMETERS

  • ACQ_FPS Acquisition frequency.

  • ACQ_FORMAT Index of the acquisition format to use. Possible values can be known by using freeture with --listformats and -d option.

  • ACQ_RES_CUSTOM_SIZE Enable custom resolution. Values : true or false.

  • ACQ_RES_SIZE If ACQ_RES_CUSTOM_SIZE is true, this parameter defines the camera image size in this format : WIDTHxHEIGHT (example : 640x480)

  • SHIFT_BITS Enable to shift bits on images. It has to be used for gige dmk cameras in MONO12.

  • ACQ_MASK_ENABLED Use mask to accelerate detection process and avoid false detections in some image's areas.

  • ACQ_MASK_PATH Path of the mask to apply on each frame for the detection process.

  • ACQ_BUFFER_SIZE Size of the buffer which keep n last frames in memory. Size in seconds.

  • ACQ_NIGHT_EXPOSURE Exposure time (in us) value to use during night.

  • ACQ_NIGHT_GAIN Gain value to use during night.

  • ACQ_DAY_EXPOSURE Exposure time (in us) value to use during daytime.

  • ACQ_DAY_GAIN Gain value to use during daytime.

  • EPHEMERIS_ENABLED Use auto-computation of sun ephemeris.

  • SUN_HORIZON_1 Value in degree. Define the height of the sun at the horizon where we want to consider the start of sunrise and the end of sunset.

  • SUN_HORIZON_2 Value in degree. Define the height of the sun at the horizon where we want to consider the end of sunrise and the start of sunset.

  • SUNRISE_TIME If EPHEMERIS_ENABLED parameter is disabled, this sunrise time will be used. Value : "HH:MM" format

  • SUNSET_TIME If EPHEMERIS_ENABLED parameter is disabled, this sunset time will be used. Value : "HH:MM" format

  • SUNRISE_DURATION Duration of the sunrise after the time define in SUNRISE_TIME.

  • SUNSET_DURATION Duration of the sunset after the time define in SUNSET_TIME.

  • EXPOSURE_CONTROL_FREQUENCY Define the interval time between exposure control. Exposure time is auto adjusted during sunrise and sunset. Value : Integer (seconds)

  • EXPOSURE_CONTROL_SAVE_IMAGE Save jpeg image at each adjustment of exposure time.

REGULAR CAPTURES

  • ACQ_REGULAR_CAPTURE Enable or disable regular capture of images.

  • ACQ_REGULAR_MODE There are three available modes : DAY, NIGHT, DAYNIGHT

  • DAY Images are only regularly captured form start of dawn until end of twilight.
  • NIGHT Images are only regularly captured from end of twilight until start of dawn.
  • DAYNIGHT Images are always regularly captured.

  • ACQ_REGULAR_CFG Define configuration of regular captures. Format : HHhMMmSSsEEeGGgFFfNn h,m,s,e,g,f,n are required separators. It respectively means hours, minutes, seconds, exposure, gain, format, repetition. HH, MM, SS, EE, GG, FF(8 or 12), N are the values.

  • ACQ_REGULAR_OUPUT Format ouput of regular captures. Possible values are

  • JPEG
  • FITS

SCHEDULED CAPTURES

  • ACQ_SCHEDULE_ENABLED Enable (true) or disable (false) scheduled acquisition.

  • ACQ_SCHEDULE List of scheduled acquisition. The format used is HHhMMmSSsEEeGGgFFfNn. h,m,s,e,g,f,n are required separators. It respectively means hours, minutes, seconds, exposure, gain, format, repetition. HH, MM, SS, EE, GG, FF(8 or 12), N are the values. Between several scheduled acquisition, the separator "," must be used. Example in configuration.cfg : ACQ_SCHEDULE = 23h10m00s10000000e300g12f1n, 02h10m00s1000000e300g12f1n, 04h10m00s5000000e300g8f2n

  • ACQ_SCHEDULE_OUTPUT Format ouput of captures. Possible values are

  • JPEG
  • FITS

DETECTION PARAMETERS

  • DET_ENABLED Enable (true) or disable (false) detection process.

  • DET_MODE There are three possible values.

  • DAYDetection only run dunring daytime.
  • NIGHTDetection only run dunring night.
  • DAYNIGHTDetection runs all the time.

  • DET_DEBUG Enable (true) or disable (false) the debug of detection method. Mainly used when CAMERA_TYPE is VIDEO or FRAMES.

  • DET_DEBUG_PATH Directory where to save data for debugging.

  • DET_TIME_AROUND Time to keep and save, in seconds, before and after a detected event.

  • DET_TIME_MAX Maximum time in seconds for a detected event.

  • DET_METHOD Choose a detection method. For now, there is just one : TEMPORAL_MTHD

  • DET_SAVE_FITS3D Enable (true) or disable (false) to save fits3D for a detected event.

  • DET_SAVE_FITS2D Enable (true) or disable (false) to save fits2D for each frame of a detected event.

  • DET_SAVE_SUM Enable (true) or disable (false) to save a sum image of the detected event.

  • DET_SAVE_SUM_WITH_HIST_EQUALIZATION Enable histogram equalization on the sum of the detected event.

  • DET_SAVE_AVI Enable (true) or disable (false) to save .avi for a detected event.

  • DET_UPDATE_MASK Enable (true) or disable (false) to create an auto mask (for sun or moon).

  • DET_DEBUG_UPDATE_MASK Enable (true) or disable (false) to debug the auto mask.

  • DET_DOWNSAMPLE_ENABLED If DET_METHOD is TEMPORAL_MTHD, this parameter enable to downsample each frame by 2.

  • DET_SAVE_GEMAP Enable (true) or disable (false) to save the map of global events.

  • DET_SAVE_DIRMAP Enable (true) or disable (false) to save the map of event direction.

  • DET_LE_MAX If DET_METHOD is TEMPORAL_MTHD, this parameter sets the maximum number of Local event for each frame.

  • DET_GE_MAX If DET_METHOD is TEMPORAL_MTHD, this parameter sets the maximum number of global event.

  • DET_SAVE_GE_INFOS If DET_METHOD is TEMPORAL_MTHD, this parameter save informations about global events.

STACK PARAMETERS

  • STACK_ENABLED Enable (true) or disable (false) to stack frames.

  • STACK_MODE There are three possible values.

  • DAYStacking process only run dunring daytime.
  • NIGHTStacking process only run dunring night.
  • DAYNIGHTStacking process runs all the time.

  • STACK_TIME Time to stack (in seconds).

  • STACK_INTERVAL Time between consecutives stacks(in seconds).

  • STACK_MTHD SUM or MEAN stacked frames.

  • STACK_REDUCTION Enable (true) or disable (false) dynamic reduction to 16 bits.

GENERAL PARAMETERS

  • DATA_PATH Absolute path where to save data (stacks and events)

  • LOG_PATH Absolute path where to save logs.

  • LOG_ARCHIVE_DAY Number of days while keep logs.

  • LOG_SIZE_LIMIT Define a limit in mo about logs consumption on the harddisk. If the logs directory is bigger than this value, logs will be deleted.

  • LOG_SEVERITY Define the level of severity for log messages to keep.

STATION INFORMATIONS

  • STATION_NAME Name of the station with the camera.

  • TELESCOP Name of the station. It's a value which will be in fits keywords.

  • OBSERVER Person in charge. It's a value which will be in fits keywords.

  • INSTRUME Instrument name. It's a value which will be in fits keywords.

  • CAMERA Camera model name. It's a value which will be in fits keywords.

  • FOCAL Camera focal. It's a value which will be in fits keywords.

  • APERTURE Camera aperture. It's a value which will be in fits keywords.

  • SITELONG Longitude of the station position in decimal degrees. It's a value which will be in fits keywords.

  • SITELAT Latitude of the station position in decimal degrees. It's a value which will be in fits keywords.

  • SITEELEV Elevation of the station position in meters. It's a value which will be in fits keywords.

MAIL CONFIGURATION

  • MAIL_DETECTION_ENABLED Enable (true) or disable (false) to send mail notification when a detection occurs.

  • MAIL_SMTP_SERVER SMTP server for routing mails. Example for gmail : smtp.gmail.com

  • MAIL_CONNECTION_TYPE There are two possible values

  • NO_SECURITY
  • USE_SSL

  • MAIL_SMTP_LOGIN Login for smtp connection.

  • MAIL_SMTP_PASSWORD Password encrypted in base64. This is not very well secured. Be carefull.

  • MAIL_RECIPIENT Mail notification recipient. To defined several recipients, separate their mail adress by ","

Smile! You are on FreeTure wiki!

Clone this wiki locally