Skip to content

Commit 07f3064

Browse files
committed
Update function details
1 parent 99ab0f0 commit 07f3064

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

src/imcflibs/imagej/misc.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -434,13 +434,13 @@ def get_threshold_value_from_method(imp, method, ops):
434434
def write_ordereddict_to_csv(out_file, content):
435435
"""Write data from a list of OrderedDicts to a CSV file.
436436
437-
In order to save the results of an analysis, looping over files,
438-
making an OrderedDict help structure the data. If a list is made
439-
containing all these OrderedDict, this function will write the data to
440-
a CSV file, preserving the order of columns as defined in the
441-
OrderedDict objects. If the output file doesn't exist, it creates a
442-
new file with a header row. If the file exists, it appends the data
443-
without repeating the header.
437+
When performing measurements in an analysis that is e.g. looping over
438+
multiple files, it's useful to keep the results in `OrderedDict` objects,
439+
e.g. one per analyzed file / dataset. This function can be used to create a
440+
CSV file (or append to an existing one) from a list of `OrderedDict`s. The
441+
structure inside the dicts is entirely up to the calling code (i.e. it's not
442+
related to ImageJ's *Results* window or such), the only requirement is
443+
type-consistency among all the `OrderedDict`s provided to the function.
444444
445445
Parameters
446446
----------

0 commit comments

Comments
 (0)