Skip to content

Commit f627bd9

Browse files
committed
update doctrings for topostats_objects input arguments
1 parent 66e74f1 commit f627bd9

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

topostats/processing.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1025,8 +1025,8 @@ def process_scan(
10251025
Parameters
10261026
----------
10271027
topostats_object : TopoStats
1028-
A dictionary with keys 'image', 'img_path' and 'pixel_to_nm_scaling' containing a file or frames' image, it's
1029-
path and it's pixel to namometre scaling value.
1028+
A Topostats object with attributes 'image', 'img_path' and 'pixel_to_nm_scaling' containing a file or frames' image, its
1029+
path and its pixel to namometre scaling value.
10301030
base_dir : str | Path
10311031
Directory to recursively search for files, if not specified the current directory is scanned.
10321032
filter_config : dict
@@ -1281,7 +1281,7 @@ def process_filters(
12811281
Parameters
12821282
----------
12831283
topostats_object : Topostats
1284-
TopoStats object - Needs further info
1284+
An object of type ``TopoStats`` class with a minimum of ``image_original``, ``filename`` and ``pixel_to_nm_scaling`` attributes which allow filtering to be run.
12851285
base_dir : str | Path
12861286
Directory to recursively search for files, if not specified the current directory is scanned.
12871287
filter_config : dict
@@ -1348,7 +1348,7 @@ def process_grains(
13481348
Parameters
13491349
----------
13501350
topostats_object : TopoStats
1351-
TopoStats object - Needs further info
1351+
An object of type ``TopoStats`` class.
13521352
13531353
base_dir : str | Path
13541354
Directory to recursively search for files, if not specified the current directory is scanned.

0 commit comments

Comments
 (0)