.config

; IMPORTANT: There always must be at least one space after the argument value and before the semicolon in front of the comment.
; For example, "parameter: value ; comment" is correct, while "parameter: value; comment" is incorrect.

[System]

stationID: XX0001
latitude: 43.19301 ; WGS84 +N  (degrees )
longitude: -81.315555 ; WGS84 +E (degrees)
elevation: 327 ; mean sea level EGM96 geoidal datum, not WGS84 ellipsoidal (meters)

; Should be set only if full CAMS compatibility is desired
cams_code: 0 

; Show this camera on the GMN weblog
weblog_enable: true

; The description that will be shown on the weblog (e.g. location, pointing direction)
weblog_description: none


; Server will generate obfuscated coordinates for public datasets.
; Optionally, uncomment and populate the three parameters below to use a specific public location if desired. 
; The recommended precision is two decimal places for latitude and longitude, and ~10 m for elevation.
; public_latitude: 0.0 ; WGS84 +N (degrees)
; public_longitude: 0.0 ; WGS84 +E (degrees)
; public_elevation: 0.0

; Camera network (e.g. national networks, used for grouping on the weblog). 
; Separate by comma for multiple networks
network_name: none
; Camera group (e.g. a camera cluster or a location with multiple cameras)
camera_group_name: none



; External script
; An external script will be run after RMS finishes the processing for the night, it will be passed 
; three arguments:
;   captured_night_dir, archived_night_dir, config - captured_night dir is the full path to the 
;   captured folder of the night, the second one is the archived, and config is an object holding 
;   the values in this config file.
; ---------------
; Enable running an external script at the end of every night of processing
external_script_run: false
; Run the external script after auto reprocess. "auto_reprocess" needs to be "true" for this to work.
auto_reprocess_external_script_run: false
; Full path to the external script
external_script_path: /home/dvida/Desktop/rms_external.py
; Name of the function in the external script which will be called
external_function_name: rmsExternal


; Daily reboot
; ---------------
; Reboot the computer daily after the processing and upload is done
reboot_after_processing: true
; Name of the lock file which the external script should create to prevent rebooting until the 
;   script is done. The external script should remove this file if the reboot is to run after the 
;   script finishes. This file should be created in the config.data_dir directory (i.e. ~/RMS_data).
reboot_lock_file: .reboot_lock


[Capture]

device: rtsp://192.168.42.10:554/user=admin&password=&channel=1&stream=0.sdp ; device id

; Media Backend: options are gst, cv2, or v4l2.
;
; The preferred option is 'gst', which corresponds to GStreamer Standalone. This method bypass OpenCV,
; and provides the highest timestamps accuracy.
; For the OpenCV method, choose 'cv2', this will revert to the OpenCV method which has proven to be
; stable but has poor timestamping performance. 
; To force OpenCV to use v4l2, choose 'v4l2', this will attempt to use v4l2 hardware acceleration
; with OpenCV (also has poor timestamping performance compared to gst.) 
; If gst, or v4l2 fails, the code reverts to cv2.
; If media_backend is not set, the code will first attempt to use GStreamer Direct, them OpenCV 
media_backend: gst

uyvy_pixelformat: false

width: 1280
height: 720
fps: 25.0 ; frames per second

; Camera Latency Settings for GStreamer Timestamps:
;
; The following two parameters correct for camera latency when in GStreamer Standalone mode.
; The settings are ignore when using other media_backend methods.
; The settings should be experimentally establishes for the specific setup.
;
; For example:
;
; RPi4, IMX291, 720p @ 25 FPS, VBR
;     camera_buffer = 1
;     camera_latency = 0.05
;
; If timestamps are late, increase latency. If early, decrease latency.
; Formula is:
; corrected_timestamp = timestamp - camera_buffer / fps - total_latency
;
; camera_buffer corresponds to the number of frames in the camera's internal buffer.
; Uncomment to change the default values.
;
; camera_buffer = 1 ; frames (integer)
; camera_latency = 0.05 ; delay in seconds

report_dropped_frames: false

; Region of interest, left limit. -1 to disable
roi_left: -1 
; Region of interest, right limit. -1 to disable
roi_right: -1 
; Region of interest, upper limit. -1 to disable
roi_up: -1 
; Region of interest, lower limit. -1 to disable
roi_down: -1 

; Bit depth of the camera (e.g. an 8-bit camera)
bit_depth: 8 
; Gamma of the camera. Usually 0.45 or 1.0
gamma: 1.0

; Format of files, either 'bin' (CAMS format), or 'fits' (new RMS format)
ff_format: fits

; Approx. horizontal Field-of-view in degrees
fov_w: 87
; Approx. vertical Field-of-view in degrees
fov_h: 45

; Deinterlacing -2 = global shutter, -1 = rolling shutter, 0 = even first, 1 = odd first
deinterlace_order: -1 

; A mask which is applied on every image so that nothing is detected in the masked (blacked out) region
; (DO NOT PUT A FULL PATH HERE, DO NOT CHANGE THE NAME OF THE MASK FILE - processing scripts upstream 
; expect it to be called "mask.bmp")
; The operational mask file is always assumed to be in the same directory as the config file
mask: mask.bmp 

; Directory where all data will be stored
data_dir: ~/RMS_data 
; Directory for raw captured files
captured_dir: CapturedFiles 
; Directory for archived files
archived_dir: ArchivedFiles 

; Extra available space in GB to leave on the SD card every night after the predicted size of all 
;     FF files have been taken into account
extra_space_gb: 5

; Directory for log files
log_dir: logs

; number of days of logs to keep. Default is 30. If this parameter is not present then RMS will use the default. 
logdays_to_keep: 30

; By default the system will keep 20 ArchivedFiles folders and compressed versions of the folders. 
; You can adjust these limits using the below parameters. A value of zero means do nothing ie keep everything forever.
; If these parameters are not present then RMS will use the default. 

; number of ArchivedFiles folders to keep. Default is 20. 
arch_dirs_to_keep: 20

; number of bz2 compressed archive folders to keep. Default 20. 
bz2_files_to_keep: 20

; Enable/disable showing maxpixel on the screen during capture
live_maxpixel_enable: false

; Enable/disable saving a live.jpg file in the data directory with the latest image
live_jpg: false

; Enable/disable showing a slideshow of last night's meteor detections on the screen during the day
slideshow_enable: false

; Automatically reprocess broken capture directories (due to e.g. power cut or system crash)
auto_reprocess: true

; Flag file which indicates that the previously processed files are loaded during capture resume
capture_resume_flag_file: .capture_resuming

; Wait an additional time (in seconds) after the capture is supposed to start. Used for multi-camera systems
;   for a staggered capture start
capture_wait_seconds: 0

; Randomize the wait time between 0 and capture_wait_seconds. Used for multi-camera systems
capture_wait_randomize: false

; Run detection and the rest of postprocessing at the end of the night, instead of parallel to capture
postprocess_at_end: false

; Wait an additional time (in seconds) to start the detection thread. If postprocess_at_end is set to false,
;   the delay will occur after the beginning of capture, and if it's set to true, the delay will occur after
;   the capture ends
postprocess_delay: 0


[Build]

; Compiler arguments for cython
rpi_weave: -O3 -mfpu=neon -funsafe-loop-optimizations -ftree-loop-if-convert-stores
linux_pc_weave: -O3
win_pc_weave: -Wall


[Upload]

; Flag for enabling/disabling upload to server
upload_enabled: true 
; Delay upload for the given number of minutes
upload_delay: 0
; Server address
hostname: gmn.uwo.ca 
; Standard SSH port
host_port: 22 
; Path to the SSH private key.
rsa_private_key: ~/.ssh/id_rsa 
; Directory on the server where the detected files will be uploaded to
remote_dir: files 
; Name of the file where the upload queue will be stored.
upload_queue_file: FILES_TO_UPLOAD.inf 

; Upload mode
; -----------
; By default, RMS will upload text files with meteor and star detections, secondary data products 
;     such as calibration plots, all FF image files, and all FR files with raw fireball frames.
;     This typically results in an archive of 100-500 MB in size. Some stations have limited 
;     data or bad internet connections, so a reduced data set can be uploaded to the server.
; Options:
;     1 - Normal mode. Everything is uploaded, including FF files with detections.
;     2 - Skip FFs. Everything except two FF files will be uploaded. One with the most matched stars
;         and another random one with a meteor detection.
;     3 - Skip FFs and FRs. Same as option 2, but FR files will also be skipped.
;     4 - Skip FRs, but upload everything else.
upload_mode: 1

; Upload events on demand
event_monitor_enabled: true
; Webpage to retrieve watchlist from
event_monitor_webpage: https://globalmeteornetwork.org/events/event_watchlist.txt
; Where to put the detected events
event_monitor_remote_dir: files/event_monitor
; Remote server will be as given in hostname

; Event monitor check interval (minutes)
event_monitor_check_interval: 30
event_monitor_check_interval_fast: 3



[Compression]



[FireballDetection]

; Flag for enabling/disabling fireball detection
enable_fireball_detection: true 
; Subsample to 16x16 squares (default 16)
subsampling_size: 16 
; Weight for stddev in thresholding for fireball extraction
k1: 7.0
; Absolute offset in thresholding for fireball extraction
j1: 10
; Maximum time in seconds for which line finding algorithm can run (seconds)
max_time: 6
; Average frame level at which the image will not be processed, as it will be deemed too white
white_avg_level: 220 
; Absolute minimum brightness in order to consider a pixel (0-255)
minimal_level: 40 
; How many pixels in a square to consider it as an event point (DEFAULT 8)
minimum_pixels: 8 
; Absolute number of points per frame required for flare detection
max_points_per_frame: 30 
; Multiplied with median number of points, used for flare detection
max_per_frame_factor: 10 
; If there is more event points than this threshold, randomize them
max_points: 500
; Minimum number of frames covered by event points (not just one line, but all points)
min_frames: 6 
; Minimum number of event points in a line
min_points: 8 
; Percentage of frames to extrapolate before a detected start of a meteor trail
extend_before: 0.15
; Percentage of frames to extrapolate after a detected end of a meteor trail 
extend_after: 0.15 
; Absolute minimum size for extracted frame crop
min_window_size: 100
; Absolute maximum size for extracted frame crop
max_window_size: 400 
; Threshold for dynamically determining window size
threshold_for_size: 0.9
; Maximum distance between the line and the point to be takes as a part of the same line 
distance_threshold: 70 
; Maximum allowed gap between points
gap_threshold: 150 
; Minimum range of frames that a line should cover (eliminates flash detections)
line_minimum_frame_range: 6 
; Constant that determines the influence of average point distance on the line quality
line_distance_const: 4 
; Ratio of how many points must be close to the line before considering searching for another line
point_ratio_threshold: 0.7 
; Maximum number of lines which are allowed to be found on the image
max_lines: 5 


[MeteorDetection]

; Minimum number of stars required in order to run the detection
ff_min_stars: 20

; Binning (only supported for videos, images, and vid files, but no FF files!)
; -------
; Bin images before detection (has to be a factor of 2, e.g. 2, 4, 8, etc.). The X, Y coordinates in 
; detections will be rescaled to the original size. 1 = do not bin.
detection_binning_factor: 1 
; The image can be binned by either averaging ('avg') or summing ('sum') pixel intensities in the bin window.
; Note that the output image data type is uint16, so be careful of integer overflows when using "sum" method!
detection_binning_method: avg

; Thresholding and KHT parameters
; -------------------------------
; Weight for stddev in thresholding for faint meteor detection
k1: 3.5
; Absolute levels above average in thresholding for faint meteor detection 
j1: 12 
; Maximum ratio of white to all pixels on a thresholded image (used to avoid searching on very messed up 
; images)
max_white_ratio: 0.05
; Size of the time window which will be slided over the time axis 
time_window_size: 64 
; Subdivision size of the time axis (256 will be divided into 256/time_slide parts)
time_slide: 32 
; Maximum number of lines to be found on the time segment with KHT
max_lines_det: 30 
; Minimum Frechet distance between KHT lines in Cartesian space to merge them (used for merging similar 
; lines after KHT)
line_min_dist: 50
; Width of the stripe around the line which will be used for centroiding and photometry
stripe_width: 28 

; Directory where binaries are built
kht_build_dir: build
; Name of the KHT binary
kht_binary_name: kht_module
; Extension of the KHT binary
kht_binary_extension: so

; 3D matched filter parameters
; ----------------------------
; Maximum number of points during 3D line search in faint meteor detection (used to minimize runtime)
max_points_det: 500 
; Maximum distance between the line and the point to be taken as a part of the same line, rescaled to 720x576 (if > 20, it will be divided by subsampling_size^2 to preserve compatibility with older config files)
distance_threshold_det: 5
; Maximum allowed gap between points in pixels, rescaled to 720x576 (if > 100, it will be divided by subsampling_size^2 to preserve compatibility with older config files)
gap_threshold_det: 50
; Minimum number of pixels in a strip
min_pixels_det: 10 
; Minimum number of frames per one detection
line_minimum_frame_range_det: 4 
; Constant that determines the influence of average point distance on the line quality
line_distance_const_det: 4 
; Maximum time in seconds for which line finding algorithm can run
max_time_det: 7

; Postprocessing parameters
; -------------------------
; Angle similarity between 2 lines in a stripe to be merged
vect_angle_thresh: 20 
; How many frames to check during centroiding before and after the initially determined frame range
frame_extension: 10 

; Centroiding
; ------------
; Maximum deviation of a centroid point from a LSQ fitted line (if above max, it will be rejected)
centroids_max_deviation: 2 
; Maximum distance in pixels between centroids (used for filtering spurious centroids)
centroids_max_distance: 30 

; Angular velocity filter
ang_vel_min: 2.0 ; deg/s
ang_vel_max: 51.0 ; deg/s

; Filtering by intensity
; By default the peak of the meteor should be at least 16x brighter than the background. This is the 
; multiplier that scales this number (1.0 = 16x). Disabled if the ML filter is turned on.
min_patch_intensity_multiplier: 0.0

; Detection filtering by machine learning. This was only optimized on moderate field of view images and
; IMX291 and IMX307 data. Disable by setting to -1. The recommended threshold is 0.85. This will disable 
; the min_patch_intensity_multiplier filtering method.
ml_filter: 0.85

[StarExtraction]

; Extract stars
; -------------
; Maximum mean intensity of an image before it is discarded as too bright
max_global_intensity: 140 
; Apply a mask on the detections by removing all that are too close to the given image border (in pixels)
border: 15 
; Size of the neighbourhood for the maximum search (in pixels)
neighborhood_size: 10
; A threshold for cutting the detections which are too faint (0-255)
intensity_threshold: 18
; An upper limit on number of stars before the PSF fitting (more than that would take too long to process)
max_stars: 400

; PSF fit and filtering
; ---------------------
; Radius (in pixels) of image segment around the detected star on which to perform the fit
segment_radius: 4 
; Minimum ratio of 2D Gaussian sigma X and sigma Y to be taken as a stars (hot pixels are narrow, while 
; stars are round)
roundness_threshold: 0.5 
; Maximum ratio between 2 sigma of the star and the image segment area
max_feature_ratio: 0.8 


[Calibration]

; True - use flat for calibration, false - do not use flat
use_flat: false 
; Name of the flat field file
flat_file: flat.bmp 
; Minimum number of FF images for making a flat
flat_min_imgs: 30 

; Star catalog
; ------------
; Name of the folder where the star catalog are kept
star_catalog_path: Catalogs 
; Catalog file name (GAIA DR2 by default)
star_catalog_file: gaia_dr2_mag_11.5.npy 
; Ratio of B, V, R, I bands - use this only for the STARS9TH_VBVRI.txt catalog
;star_catalog_band_ratios: 0.1,0.32,0.23,0.35 

; Platepar
; --------
; The default name of the PlatePar file (DO NOT CHANGE THIS)
; The operational platepar file is always assumed to be in the same directory as the config file
platepar_name: platepar_cmn2010.cal 
; Name of the JSON file with recalibrated platepars for constant intervals of FF files
platepars_flux_recalibrated_name: platepars_flux_recalibrated.json
; Name of the JSON file with recalibrated platepars for every FF file
platepars_recalibrated_name: platepars_all_recalibrated.json
; Name of the new platepar file on the server
platepar_remote_name: platepar_latest.cal 
; Name of the directory on the server which contains platepars
remote_platepar_dir: platepars

; Auto recalibration
; -----------
; The limiting magnitude of the used stars, used for filtering out catalog stars which are fainter then 
; the system can detect
catalog_mag_limit: 5.2
; How many calstars FF files to evaluate 
calstars_files_N: 400 
; Minimum number of stars to use
calstars_min_stars: 1000 
; A minimum number of stars on the image for accepting the image
min_matched_stars: 20
; If the average distance (pixels) between catalog and image stars is below this threshold, astrometry 
; recalibration will not run but the existing calibration will be used
dist_check_threshold: 0.33 
; If the averge distance (pixels) is below this number, only a quick recalibration procedure will run
dist_check_quick_threshold: 0.4


[Thumbnails]

; Thumbnail binning
thumb_bin:      4
; How many images will be stacked per each thumbnail
thumb_stack:    5
; Number of thumbnails in each row
thumb_n_width: 10


[Stack]

; Whether to apply the mask to stack or not
stack_mask: false


[Timelapse]

; Automatically generate a timelapse using all FF files at the end of the night
timelapse_generate_captured: true


[Colors]
; colour palette to use for various charts -can be any matplotlib colour scheme
; other options are gist_ncar, rainbow, gist_rainbow, inferno 

shower_color_map: gist_ncar