.config

; IMPORTANT: Unlike other RMS files, the '.config' file is never automatically
; updated. When changes are introduced to the config file in RMS, these changes
; will NOT be automatically reflected in the active '.config' file on 
; individual machines. Users should manually update their '.config' file if 
; changing any option from its default value is desired, or to simply stay 
; up-to-date. If an option is missing from the config file, a default value 
; will be automatically applied.
; An up-to-date template config '.configTemplate' file, containing the current
; options, is located in the RMS root directory.
; Run python -m Utils.AuditConfig to compare the .config file to the template. 

[System]

; The assigned station ID
stationID: XX0001

; WGS84 +N (degrees)
latitude: 43.19301

; WGS84 +E (degrees)
longitude: -81.315555

; Mean sea level EGM96 geoidal datum, not WGS84 ellipsoidal (meters)
; Can be obtained from Google Earth or other apps. Raw GPS altitude should not
; be used as the software converts from EGM96 to WGS84 internally.
elevation: 327

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

; Weblog and PerfMonitor
; ----------------------

; Show this camera on the GMN weblog
weblog_enable: true

; The description 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.
;
; WGS84 +N (degrees)
; public_latitude: 0.0
;
; WGS84 +E (degrees)
; public_longitude: 0.0
;
; mean sea level EGM96 (meters)
; 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
; ---------------

; Enable running an external script at the end of every night. it will be passed
; three arguments: captured_night_dir, archived_night_dir, config 
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: none

; Name of the function in the external script to be called
external_function_name: rmsExternal

; Daily reboot
; ---------------

; Reboot the computer daily after processing and upload
reboot_after_processing: true

; Lock file name for preventing 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 URL
device: rtsp://192.168.42.10:554/user=admin&password=&channel=1&stream=0.sdp

; Transport Layer Protocol: 'tcp' or 'udp'. Defaults to tcp. UDP typically
; provides more stable connectivity, but TCP has a longer track record.
protocol: tcp

; Media Backend: options are gst, cv2, or v4l2.
; 'gst':    (default - preferred) GStreamer Standalone. Bypass OpenCV, and
;           provides the highest timestamps accuracy.
; 'cv2':    OpenCV method. Reliable but has poor timestamping performance. 
; 'v4l2':   OpenCV with v4l2, uses v4l2 hardware acceleration with OpenCV.
; If gst, or v4l2 return an error, the code reverts to cv2.
media_backend: gst

; Gstreamer color space to use. Only applicable if media_backend is gst.
; Examples: BGR, GRAY8
gst_colorspace: BGR

; Gstreamer decoder element to use. Only applicable if media_backend is gst.
; Examples: decodebin, avdec_h264, nvh264dec
gst_decoder: avdec_h264

uyvy_pixelformat: false

; The capture device resolution
width: 1280
height: 720

; Region of interest. -1 to disable
roi_left: -1
roi_right: -1
roi_up: -1
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


; Frames per second (FPS) are precisely calculated and reported at the end of
; each capture session when in GStreamer standalone mode. This information can
; be found in each session's log by searching for 'Last Calculated FPS'. Please
; update the value here with the log's reported value. The calculate FPS
; often differs from the nominal FPS, usually by less than 0.1%.
; Example: fps: 24.98122
fps: 25.0

; Camera Latency Settings for GStreamer Timestamps
; ------------------------------------------------
; The following two parameters correct for camera latency when in GStreamer
; Standalone mode. The settings are ignored 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. If these parameters are not present then RMS will use the default. 

; frames (integer). Default is 1
camera_buffer: 1

; delay in seconds. Default is 0.05 s (50 ms)
camera_latency: 0.05

; Log dropped frames. Only reliable for analog cameras
report_dropped_frames: false


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


; Approximate Field-of-view in degrees
fov_w: 87
fov_h: 45

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


; Toggle saving video frames at a set interval to the frame_dir
save_frames: true

; The file extension for saved frames ('jpg' or 'png')
frame_file_type: jpg

; Set the saved framed JPEG quality for jpg file type [0-100]
jpgs_quality: 90

; Set the saved framed PNG compression for png file type [0-9]
png_compression: 3

;  Set the time interval in seconds for saving video frames.
; CAUTION: Lower intervals can generate a large amount of data.
; Example: An 8-hour run at 25 FPS will generate different data sizes
;          depending on the interval and resolution selected.
;
;          | Inter|    Resolution     |
;          |  (s) |   720p  |  1080p  |
;          |------|---------|---------|
;          | 0.2  |  ~20 GB |  ~50 GB |
;          |   1  |   ~4 GB |  ~10 GB |
;          |   2  |   ~2 GB |   ~5 GB |
;          |   5  | ~800 MB |   ~2 GB |
;          |  10  | ~400 MB |   ~1 GB |
frame_save_interval: 5


; Run capture continuously, through day/night
continuous_capture: false

; Switch camera settings between day/night modes, for when continuous_capture is enabled
switch_camera_modes: false

; Toggle raw video saving in data_dir/video_dir
raw_video_save: false

; Duration of the raw video segment (seconds).
; If -1, the segment duration will be 256/FPS seconds
raw_video_duration: 30


; Path to the directory where all data will be stored
data_dir: ~/RMS_data

; Name of directory within data_dir for raw captured files
captured_dir: CapturedFiles

; Name of directory within data_dir for archived files
archived_dir: ArchivedFiles

; Name of directory within data_dir for saved frame files
frame_dir: FramesFiles

; Name of directory within data_dir for raw video files
video_dir: VideoFiles

; Name of directory within data_dir for log files
log_dir: logs

; Extra GB space left on the SD card nightly, accounting for the predicted
; size of all FF files.
extra_space_gb: 5

; 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.

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

; Number of days of logs to keep. Default is 30
logdays_to_keep: 30

; Control additional logging of console output messages
; Set to true to include extra console output in log file
; Note: This does not affect normal logging, only additional console messages
log_stdout: false

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

; Number of CapturedFiles folders to keep. Default is 8
capt_dirs_to_keep: 8

; Number of frame file days to keep. Default is 4
frame_days_to_keep: 4

; Number of raw video folders (days) to keep. Default is 2
video_days_to_keep: 2


; the next settings configure the archive management by space used on disk
; disabling quota management generates the reports, lists the files
; that would be deleted but prevents any action from being taken
; true = disabled, false = enabled
quota_management_disabled: true

; Any one of the next three parameters missing or commented out disables
; the quota management.
; Each of the parameters is in GB.

; Overall space allowance for the data directory, typically RMS_data
rms_data_quota: 4000

; Space allowance for the archived directories, and files contained within
arch_dir_quota: 100

; Space allowance for the bz2 files
bz2_files_quota: 100

; Therefore the space allowed for the CapturedFiles directory is
; rms_data_quota - (arch_dir_quota + bz2_files_quota)
; space used by log files and .db files is ignored


; Toggle showing maxpixel on the screen during capture
live_maxpixel_enable: false

; Toggle saving a single jpg with the latest maxpixel image in the data dir
live_jpg: false


; Toggle daytime slideshow of last night's meteor detections
slideshow_enable: false

; Auto-reprocess broken capture directories after power cuts or crashes
auto_reprocess: true

; Prioritize capture over reprocessing.
; Do not start reprocessing a new directory if should be capturing
prioritize_capture_over_reprocess: false

; Flag file to load processed files on capture resume
capture_resume_flag_file: .capture_resuming

; Additional wait time (seconds) for staggered start in multi-camera setups
capture_wait_seconds: 0

; Randomize wait time (0 to capture_wait_seconds) for multi-camera systems.
capture_wait_randomize: false

; Process detection and postprocessing at night's end, not during capture.
postprocess_at_end: false

; Add extra seconds before starting detection: after capture begins if
; postprocess_at_end is false, or after capture ends if true.
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 meteor 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

; Event Monitor
; -------------
; Upload events on demand
event_monitor_enabled: true

; Webpage for watchlist
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

; Max runtime (seconds) for the line finding algorithm.
max_time: 6

; Threshold average frame level beyond which images are considered too white to
; process
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

; Percent of frames to extrapolate before a meteor trail's detected start
extend_before: 0.15

; Percent of frames to extrapolate after a meteor trail's detected end
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

; Max distance for a point to be considered part of the same line
distance_threshold: 70

; Maximum allowed gap between points
gap_threshold: 150

; Minimum frame range a line must span to exclude flash detections
line_minimum_frame_range: 6

; Constant affecting average point distance's impact on line quality.
line_distance_const: 4

; Ratio of points near a line needed before seeking 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 to merge KHT lines in Cartesian space
; (used for merging similar lines after KHT)
line_min_dist: 50

; Stripe width around the line 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 (deg/s)
ang_vel_min: 2.0
ang_vel_max: 51.0

; 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

; Number of CPU cores to use for the detection.
; If set to <=0, (all cores + num_cores) will be used
num_cores: -1


[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
; Options:
; - GMN_StarCatalog - GMN star catalog, up to 12.0 mag (DEFAULT)
; - BSC5 - Bright Star Catalog 5th edition
; - gaia_dr2_mag_11.5.npy - Gaia DR2 catalog, up to 11.5 mag
; - STARS9TH_VBVRI.txt - Sky2000 catalog, up to 9.0 mag
star_catalog_file: GMN_StarCatalog

; Ratio of B, V, R, I, G, BP, RP bands. 
; Only works with GMN_StarCatalog and STARS9TH_VBVRI.txt
; For GMN_StarCatalog:
; - B, V, R, I, GAIA G, BP, RP are available, with the latter three being GAIA bands
; For STARS9TH_VBVRI.txt:
; - Only B, V, R, I are available (the rest are ignored). If they are all set to zero, V band will be used
;                            B,   V,   R,   I,   G,  BP,  RP
star_catalog_band_ratios: 0.00,0.00,0.00,0.00,1.00,0.00,0.00


; Platepar and mask
; -----------------

; 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

; Toggle downloading remote mask
mask_download_permissive: true

; 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

; Maximum number of stars to use for the fit on individual images
recalibration_max_stars: 200

; 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 average 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
timelapse_generate_captured: true

; Automatically generate a timelapse using all saved frame files
timelapse_generate_from_frames: true



[Colors]

; color palette to use for various charts -can be any matplotlib color scheme
; other options are gist_ncar, rainbow, gist_rainbow, inferno 
shower_color_map: gist_ncar