Commit d01ae340 authored by Holger Niemann's avatar Holger Niemann
Browse files

documentation update

parent 79b9fe3d
......@@ -136,8 +136,6 @@ def TimeToNs(date, time):
------
nsdate: integer
nanosecond since 1.1.1970 0:00:00
"""
date_time = datetime.datetime(date[0], date[1], date[2], time[0], time[1],
time[2], time[3])
......@@ -198,6 +196,14 @@ def download_LUT(port, time, exposure=0, emissivity=0, camera_filter=0, version=
Have to swap 11, 21 until correction in the database
INPUT
------
port:
time:
exposure:
emissivity:
camera_filter:
version:
testmode:
verbose:
RESULT
------
......@@ -2061,7 +2067,8 @@ def get_TC_data_for_port_by_program(port, program, part=0, version=0, verbose=0)
"""
INPUT
------
verbose: integer, optional, default 0
feedback level (details of print messages)
RESULT
------
......@@ -2213,7 +2220,8 @@ def get_temp_from_raw_by_program_V1(portnr, program, time_window=0, emi=0.8,dive
"""
INPUT
------
verbose: integer, optional, default 0
feedback level (details of print messages)
RESULT
------
......@@ -2310,7 +2318,8 @@ def get_temp_from_raw_by_program_V2(portnr, program, time_window=0, emi=0.8, ver
"""
INPUT
------
verbose: integer, optional, default 0
feedback level (details of print messages)
RESULT
------
......@@ -2330,7 +2339,8 @@ def get_temp_from_raw_by_program(portnr, program, time_window=0, emi=0.8, T_vers
"""
INPUT
------
verbose: integer, optional, default 0
feedback level (details of print messages)
RESULT
------
......@@ -2529,7 +2539,8 @@ def get_temp_from_raw_by_program_fullthreads(portnr, program, time_window=0, emi
"""
INPUT
------
verbose: integer, optional, default 0
feedback level (details of print messages)
RESULT
------
......@@ -2663,7 +2674,8 @@ def get_nuced_raw_by_program(portnr, program, time_window=0,version=0,
"""
INPUT
------
verbose: integer, optional, default 0
feedback level (details of print messages)
RESULT
------
......@@ -2712,7 +2724,8 @@ def get_nuced_raw_by_program_fullthreads(portnr, program, time_window=0, emi=0.8
"""
INPUT
------
verbose: integer, optional, default 0
feedback level (details of print messages)
RESULT
------
......@@ -2824,7 +2837,8 @@ def apply_calib_on_raw(images, background, LUT,refT=28.5, gain=0, offset=0, gain
INPUT
------
verbose: integer, optional, default 0
feedback level (details of print messages)
RESULT
------
......@@ -2962,7 +2976,8 @@ def get_calib_data(port, program=None, t0=None, t1=None, t6=None, emissivity=0.8
INPUT
------
verbose: integer, optional, default 0
feedback level (details of print messages)
RESULT
------
......@@ -3165,7 +3180,8 @@ def find_badpixels(port, gain, offset, init_bp_list=None, niterations=3,
"""
INPUT
------
verbose: integer, optional, default 0
feedback level (details of print messages)
RESULT
------
......@@ -3332,7 +3348,8 @@ def estimate_offset(port, program, plot_it=False, verbose=0):
"""
INPUT
------
verbose: integer, optional, default 0
feedback level (details of print messages)
RESULT
------
......@@ -3378,7 +3395,8 @@ def download_heatflux_by_program(port, program, time_window=0, testmode=False,
INPUT
------
verbose: integer, optional, default 0
feedback level (details of print messages)
RESULT
------
......@@ -3434,7 +3452,8 @@ def download_heatflux_by_times(port, tstart, tend, time_window=0, threads=1, tes
INPUT
------
verbose: integer, optional, default 0
feedback level (details of print messages)
RESULT
------
......@@ -3525,7 +3544,8 @@ def download_heatflux_mapping_reference(timepoint=None, version=0, testmode=Fals
INPUT
------
verbose: integer, optional, default 0
feedback level (details of print messages)
RESULT
------
......@@ -3666,7 +3686,8 @@ def download_heatflux_scene_model_reference(port, timepoint=None, program=None,
INPUT
------
verbose: integer, optional, default 0
feedback level (details of print messages)
RESULT
------
......@@ -3739,7 +3760,8 @@ def give_finger_ID(profile, finger=None, verbose=0):
INPUT
------
verbose: integer, optional, default 0
feedback level (details of print messages)
RESULT
------
......@@ -3840,7 +3862,8 @@ def get_heatflux_profile(port, profile, finger=None, timepoint=None, program=Non
INPUT
------
verbose: integer, optional, default 0
feedback level (details of print messages)
RESULT
------
......@@ -3927,7 +3950,22 @@ def extract_heatflux_profile_from_DL(time, images, profile, finger=None, time_wi
INPUT
------
time:
images:
profile:
finger:
time_window:
inputchecked:
verbose: integer, optional, default 0
feedback level (details of print messages)
testmode: boolean, optional, default 0
if True, the data will be loaded from the test archive
RESULT
------
......@@ -4099,8 +4137,8 @@ def download_divertor_load(port, targetmodule=None, program=None, tstart=None,
version: int
verbose: int
verbose: integer, optional
feedback level (details of print messages)
testmode:
request: boolean, optional, default True
......@@ -4263,16 +4301,17 @@ def download_scene_model(port, program=None, timepoint=None, version=0, testmode
timepoint: int64, optional
nanosecond timestamp to indicate the validation window of the scene model
version: integer, optional
Version of the data in the archiveDB, in case of 0 the highest version will be used
testmode: boolean, optional
verbose: integer, optional
if True, the data will be loaded from the test archive
verbose: integer, optional
feedback level (details of print messages)
RESULT
------
exist: boolean
indicates whether data was found (True) or not (False)
scene_model: dict
dictionary of the different images in the scene model (see keys for describtion)
dictionary of the different images in the scene model (see keys for describtion)
NOTES
-----
......
......@@ -16,8 +16,8 @@ if __name__ == '__main__':
#%% loading data
print(datetime.datetime.now(), "start")
status, time, images, valid = downIR.get_temp_from_raw_by_program(10,
"20180920.017",
status, time, images, valid = downIR.get_temp_from_raw_by_program(51,
"20171206.045",
time_window=[1, 1.1],
emi=0.8,
T_version=2,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment