jrkerns / pylinac

An image analysis library for medical physics
MIT License
145 stars 94 forks source link

Incorrect Documentation of CBCT Analysis? #398

Closed t-milan closed 2 years ago

t-milan commented 3 years ago

In the documentation of the CatPhan module, the following is stated in regards to HU linearity: "The mean pixel value of the ROI is the stated HU value."

However, in ROI.py, it seems to take the median:

@cached_property
def pixel_value(self) -> float:
    """The median pixel value of the ROI."""
    masked_img = self.circle_mask()
    return float(np.nanmedian(masked_img))

Am I correct in that this is an error in the documentation?

jrkerns commented 2 years ago

Yes, will update. Thanks

jrkerns commented 2 years ago

Updated in latest and v3.0 docs