CsatiZoltan / CristalX

Identification and analysis of polycrystalline microstructures
https://cristalx.readthedocs.io
GNU Lesser General Public License v3.0
6 stars 7 forks source link

Class for labeled images #47

Open CsatiZoltan opened 3 years ago

CsatiZoltan commented 3 years ago

More and more functions work on labeled images in the codebase. Currently, these are

in the analysis module and

in the segmentation module.


It is time to collect them in a class. We will call this class LabeledImage1 and it should have, at first thought, the following methods:

and with the following data members:

Once the class has been created, deprecate the old functions and also mention this class creation principal as an example under the "Do not overuse classes" bullet point of the program design.


1 MATLAB calls it "label image". However, the word "label" is also a verb and we want to avoid the misunderstanding that we perform labeling as done in computer vision. We also prefer "labeled" to "labelled" as American English is used in the rest of CristalX. 2 Other values for the color parameter: