Formats code à la Visual Studio Code

.gitignore

@@ -6,3 +6,4 @@
 .\#*
 ._.DS_Store
 ._*
+.vscode

README.md

@@ -106,6 +106,7 @@ We defined a SPICE data object, called SPICE_DATA, which can be initiated with a
 contains many methods to handle the data and the header contained in the given FITS file. It can be created 
 using one of these commands:
 ```
+spice_object = spice_object(spice_file)          ; flexible form, accepts also level 3 files
 spice_object = spice_data(spice_file)            ; short form
 spice_object = obj_new('spice_data', spice_file) ; long form
 ```
@@ -204,7 +205,7 @@ There are several useful tools to manage SPICE files:
 This repository includes a pre-commit git hook, that updates a specific line of each modified file with the current 
 date and time. The line with this format will be edited:
 ```
-; $Id: 2024-02-09 14:12 CET $
+; $Id: 2024-11-26 11:40 CET $
 ```
 If the file you modified, does not contain this line yet, please add it, preferably append it to the procedure 
 description at the beginning of the file. 

objects/spice_create_l3_progress__define.pro

@@ -37,7 +37,7 @@
 ; PROCEDURE:
 ;
 ; RESTRICTIONS:
-; 
+;
 ; EXAMPLE:
 ; pro create_l3_file, file, progress_widget
 ;   progress_widget->next_file, n_windows, halt=halt
@@ -49,7 +49,7 @@
 ;   ENDFOR
 ;   ; write l3 file
 ; end
-; 
+;
 ; pro create_many_l3_files
 ;   progress_widget = spice_create_l3_progress(files=spice_l2_files)
 ;   FOR ifile=0,N_ELEMENTS(spice_l2_files)-1 DO BEGIN
@@ -61,8 +61,7 @@
 ; HISTORY:
 ;     06-Dec-2022: Martin Wiesmann, UIO, ITA.
 ;-
-; $Id: 2023-06-13 13:52 CEST $
-
+; $Id: 2024-11-27 10:44 CET $
 
 ;+
 ; Description:
@@ -77,12 +76,12 @@
 ; OUTPUT:
 ;     1 (True) if initialization succeeded, 0 (False) otherwise.
 ;-
-FUNCTION spice_create_l3_progress::init, n_files, files=files, group_leader=group_leader
+FUNCTION spice_create_l3_progress::init, n_files, files = files, group_leader = group_leader
   COMPILE_OPT IDL2
 
   prits_tools.parcheck, files, 0, "files", 'string', [0, 1], /optional
-  n_files_in = N_ELEMENTS(files)
-  prits_tools.parcheck, n_files, 1, "n_files", 'INTEGERS', 0, MINVAL=1, optional=n_files_in
+  n_files_in = n_elements(files)
+  prits_tools.parcheck, n_files, 1, "n_files", 'INTEGERS', 0, MINVAL = 1, optional = n_files_in
 
   IF n_files_in GT 0 THEN BEGIN
     self.n_files = n_files_in
@@ -91,7 +90,7 @@ FUNCTION spice_create_l3_progress::init, n_files, files=files, group_leader=grou
     self.n_files = n_files
     self.files_given = 0
     files = strarr(n_files)
-    for i=0,n_files-1 do files[i]=fns('File ######', i)
+    FOR i = 0, n_files - 1 DO files[i] = fns('File ######', i)
   ENDELSE
   self.files = ptr_new(files)
   temp = strlen(strtrim(self.n_files, 2))
@@ -100,43 +99,41 @@ FUNCTION spice_create_l3_progress::init, n_files, files=files, group_leader=grou
   self.i_file = -1
   self.halt = 0
 
-  self.base = widget_base(/column, title='Progress of creation of SPICE level 3 files')
-  self.slider_total = widget_slider(self.base, xsize=400, minimum=0, maximum=100, $
-    title='Percent done over all files')
-  self.slider_file = widget_slider(self.base, xsize=400, minimum=0, maximum=100, $
-    title='Percent done within the current file')
+  self.base = widget_base(/column, title = 'Progress of creation of SPICE level 3 files')
+  self.slider_total = widget_slider(self.base, xsize = 400, minimum = 0, maximum = 100, $
+    title = 'Percent done over all files')
+  self.slider_file = widget_slider(self.base, xsize = 400, minimum = 0, maximum = 100, $
+    title = 'Percent done within the current file')
 
-  self.label_current_file_num = widget_label(self.base, value='File '+string(1, format=self.n_files_format)+ $
-    ' of '+string(1, format=self.n_files_format))
-  self.label_current_path = cw_field(self.base, title='Current path  ', /NoEdit, xsize=75)
-  self.label_current_file = cw_field(self.base, title='Current file  ', /NoEdit, xsize=75)
-  label = widget_label(self.base, value=' ')
+  self.label_current_file_num = widget_label(self.base, value = 'File ' + string(1, format = self.n_files_format) + $
+    ' of ' + string(1, format = self.n_files_format))
+  self.label_current_path = cw_field(self.base, title = 'Current path  ', /noedit, xsize = 75)
+  self.label_current_file = cw_field(self.base, title = 'Current file  ', /noedit, xsize = 75)
+  label = widget_label(self.base, value = ' ') ; idl-disable-line unused-var
 
-  self.label_current_window_num = widget_label(self.base, value='Window '+string(1, format=self.n_windows_format)+ $
-    ' of '+string(1, format=self.n_windows_format))
-  self.label_current_window = cw_field(self.base, title='Current window', /NoEdit, xsize=75)
+  self.label_current_window_num = widget_label(self.base, value = 'Window ' + string(1, format = self.n_windows_format) + $
+    ' of ' + string(1, format = self.n_windows_format))
+  self.label_current_window = cw_field(self.base, title = 'Current window', /NoEdit, xsize = 75)
 
-  self.list_files = widget_list(self.base, value=file_basename(files), /frame, xsize=75, scr_ysize=200)
-  self.stop_button = widget_button(self.base, value='Stop creation of level 3 files')
-  wp = widget_positioner(self.base, parent=group_leader)
-  wp->position, /left_align
+  self.list_files = widget_list(self.base, value = file_basename(files), /frame, xsize = 75, scr_ysize = 200)
+  self.stop_button = widget_button(self.base, value = 'Stop creation of level 3 files')
+  wp = widget_positioner(self.base, parent = group_leader)
+  wp.position, /left_align
 
   return, 1
 END
 
-
 ;+
 ; Description:
 ;     This procedure is called if the object is destroyed, it frees all pointers and kills all widgets.
 ;-
-pro spice_create_l3_progress::cleanup
+PRO spice_create_l3_progress::cleanup
   COMPILE_OPT IDL2
 
   ptr_free, self.files
   xkill, self.base
 END
 
-
 ;+
 ; Description:
 ;     This procedure sets the sliders and labels to the next file to be processed. The process first
@@ -153,14 +150,14 @@ END
 ; OUTPUT:
 ;     halt: Will be set to 1 if user clicked on 'STOP' button.
 ;-
-pro spice_create_l3_progress::next_file, n_windows, filename=filename, halt=halt
+PRO spice_create_l3_progress::next_file, n_windows, filename = filename, halt = halt
   COMPILE_OPT IDL2
 
-  prits_tools.parcheck, n_windows, 1, "n_windows", 'INTEGERS', 0, MINVAL=1
+  prits_tools.parcheck, n_windows, 1, "n_windows", 'INTEGERS', 0, MINVAL = 1
   prits_tools.parcheck, filename, 0, "filename", 'string', 0, /optional
 
   event = widget_event(self.stop_button, /nowait)
-  IF event.id NE 0L THEN BEGIN
+  IF event.id NE 0l THEN BEGIN
     halt = 1
     self.halt = 1
     return
@@ -176,25 +173,24 @@ pro spice_create_l3_progress::next_file, n_windows, filename=filename, halt=halt
 
   IF ~self.files_given && keyword_set(filename) THEN BEGIN
     (*self.files)[self.i_file] = filename
-    widget_control, self.list_files, set_value=*self.files
+    widget_control, self.list_files, set_value = *self.files
   ENDIF
   self.filename = (*self.files)[self.i_file]
 
   self.i_window = -1
   self.window_name = fns('Window ##', 0)
   self.n_windows = n_windows
 
-  widget_control, self.slider_total, set_value=float(self.i_file)/float(self.n_files)*100.0
-  widget_control, self.slider_file, set_value=0
-  widget_control, self.label_current_file_num, set_value='File '+string(self.i_file+1, format=self.n_files_format)+ $
-    ' of '+string(self.n_files, format=self.n_files_format)
-  widget_control, self.label_current_path, set_value=file_dirname(self.filename)
-  widget_control, self.label_current_file, set_value=file_basename(self.filename)
-  widget_control, self.label_current_window_num, set_value='Window '+string(1, format=self.n_windows_format)+ $
-    ' of '+string(self.n_windows, format=self.n_windows_format)
-  widget_control, self.label_current_window, set_value=self.window_name
-end
-
+  widget_control, self.slider_total, set_value = float(self.i_file) / float(self.n_files) * 100.0
+  widget_control, self.slider_file, set_value = 0
+  widget_control, self.label_current_file_num, set_value = 'File ' + string(self.i_file + 1, format = self.n_files_format) + $
+    ' of ' + string(self.n_files, format = self.n_files_format)
+  widget_control, self.label_current_path, set_value = file_dirname(self.filename)
+  widget_control, self.label_current_file, set_value = file_basename(self.filename)
+  widget_control, self.label_current_window_num, set_value = 'Window ' + string(1, format = self.n_windows_format) + $
+    ' of ' + string(self.n_windows, format = self.n_windows_format)
+  widget_control, self.label_current_window, set_value = self.window_name
+END
 
 ;+
 ; Description:
@@ -210,13 +206,13 @@ end
 ; OUTPUT:
 ;     halt: Will be set to 1 if user clicked on 'STOP' button.
 ;-
-pro spice_create_l3_progress::next_window, window_name=window_name, halt=halt
+PRO spice_create_l3_progress::next_window, window_name = window_name, halt = halt
   COMPILE_OPT IDL2
 
   prits_tools.parcheck, window_name, 0, "window_name", 'string', 0, /optional
 
   event = widget_event(self.stop_button, /nowait)
-  IF event.id NE 0L THEN BEGIN
+  IF event.id NE 0l THEN BEGIN
     halt = 1
     self.halt = 1
     return
@@ -239,13 +235,12 @@ pro spice_create_l3_progress::next_window, window_name=window_name, halt=halt
   percent_file = float(self.i_file) / float(self.n_files) * 100.0
   percent_window = float(self.i_window) / float(self.n_windows)
   percent_total = percent_file + 1.0 / float(self.n_files) * percent_window * 100.0
-  widget_control, self.slider_total, set_value=percent_total
-  widget_control, self.slider_file, set_value=percent_window*100.0
-  widget_control, self.label_current_window_num, set_value='Window '+string(self.i_window+1, format=self.n_windows_format)+ $
-    ' of '+string(self.n_windows, format=self.n_windows_format)
-  widget_control, self.label_current_window, set_value=self.window_name
-end
-
+  widget_control, self.slider_total, set_value = percent_total
+  widget_control, self.slider_file, set_value = percent_window * 100.0
+  widget_control, self.label_current_window_num, set_value = 'Window ' + string(self.i_window + 1, format = self.n_windows_format) + $
+    ' of ' + string(self.n_windows, format = self.n_windows_format)
+  widget_control, self.label_current_window, set_value = self.window_name
+END
 
 ;+
 ; Description:
@@ -259,35 +254,34 @@ FUNCTION spice_create_l3_progress::halted
   return, self.halt
 END
 
-
 ;+
 ; Description:
 ;     Class definition procedure
 ;-
 PRO spice_create_l3_progress__define
   COMPILE_OPT IDL2
 
-  struct = {spice_create_l3_progress, $
-    n_files: 1, $            ; number of files to be processed
-    i_file: -1, $            ; index of current file beginning at zero
-    files: ptr_new(), $      ; list of files to be processed
-    files_given: 0b, $       ; indicates whether list of files was given at initialization
-    n_files_format: '', $    ; format in which to display number of files
-    filename: '', $          ; name of current file
-    n_windows: 1, $          ; number of windows in current file
-    i_window: -1, $          ; index of current window beginning at zero
-    window_name: '', $       ; name of current window
-    n_windows_format: '', $  ; format in which to display the number of windows
-    halt:0b, $               ; indicates whether the user clicked on the Stop button
-    base:0L, $
-    slider_total:0L, $
-    slider_file:0L, $
-    label_current_file_num:0L, $
-    label_current_path:0L, $
-    label_current_file:0L, $
-    label_current_window_num:0L, $
-    label_current_window:0L, $
-    list_files:0L, $
-    stop_button:0L $
-  }
+  !NULL = {spice_create_l3_progress, $
+    n_files: 1, $ ; number of files to be processed
+    i_file: -1, $ ; index of current file beginning at zero
+    files: ptr_new(), $ ; list of files to be processed
+    files_given: 0b, $ ; indicates whether list of files was given at initialization
+    n_files_format: '', $ ; format in which to display number of files
+    filename: '', $ ; name of current file
+    n_windows: 1, $ ; number of windows in current file
+    i_window: -1, $ ; index of current window beginning at zero
+    window_name: '', $ ; name of current window
+    n_windows_format: '', $ ; format in which to display the number of windows
+    halt: 0b, $ ; indicates whether the user clicked on the Stop button
+    base: 0l, $
+    slider_total: 0l, $
+    slider_file: 0l, $
+    label_current_file_num: 0l, $
+    label_current_path: 0l, $
+    label_current_file: 0l, $
+    label_current_window_num: 0l, $
+    label_current_window: 0l, $
+    list_files: 0l, $
+    stop_button: 0l $
+    }
 END