deid icon indicating copy to clipboard operation
deid copied to clipboard

Specify more than one coordinates in the filter

Open NirutaDhimal opened this issue 2 years ago • 36 comments

I am trying to remove clean pixels of 2 -3 coordinates of a dicom file. How do I specify it in the filter ? [ err2 This is my filter But I want to clean pixels on bounding box 4,462,23,102. How do I add this in filter?

NirutaDhimal avatar Oct 01 '22 08:10 NirutaDhimal

Here is an example of an entry with two coordinates: https://github.com/pydicom/deid/blob/master/deid/data/deid.dicom#L301-L308

vsoch avatar Oct 01 '22 08:10 vsoch

I tried that but It's not working. Only the First coordinates were removed.

NirutaDhimal avatar Oct 01 '22 08:10 NirutaDhimal

That's a bug then! Are you able to share some dummy data so I can use for a debuggig/test case?

vsoch avatar Oct 01 '22 12:10 vsoch

Actually I have a good test case already! I should be able to work on this and propose a fix today - stay tuned!

vsoch avatar Oct 01 '22 12:10 vsoch

I don't have any dummy data. Sorry for that. Thanks

NirutaDhimal avatar Oct 01 '22 14:10 NirutaDhimal

@NirutaDhimal I tested the syntax with multiple coordinates and it appears to work as I'd expect (both sets show up):

In [1]: results['results']
Out[1]: 
[{'reason': 'and Manufacturer contains Philips Modality contains US ImageType contains Cardiology',
  'group': 'graylist',
  'coordinates': [[0, '0,0,1024,23'], [0, '0,0,1024,23']]}] # notice there are two here

I think very likely the issue is that you either have a bug in the bounding box you are asking for, or a "contains" statement that doesn't apply to your image. It's hard to debug beyond that without seeing your data. However, the format for the coordinates that I showed above is correct.

vsoch avatar Oct 01 '22 17:10 vsoch

@vsoch I printed client.detect() result and both set shows up in the coordinates. But when I did client.save(), the saved image still contains the text in the 2nd coordinate. err3

NirutaDhimal avatar Oct 06 '22 02:10 NirutaDhimal

Did you do client.clean() ?

vsoch avatar Oct 06 '22 02:10 vsoch

Yes, I did that. First I did client.detect() and then client.clean() and at last I did client.save()

NirutaDhimal avatar Oct 06 '22 03:10 NirutaDhimal

I could help to debug but I’d need you to send me a dummy example (an image and recipe) that reproduces the error. Just to confirm - this is a 2D dicom?

perhaps you could take your image, make a copy that replaces identifiers, write all pixels as some single value (e.g the mean across the image) and then we would try to clean and write a different value?

vsoch avatar Oct 06 '22 03:10 vsoch

Yes its a 2D dicom file and it has 3 channels. I will send you the dummy data

NirutaDhimal avatar Oct 06 '22 04:10 NirutaDhimal

@vsoch This link has the dummy data and the deid.dicom file. Please find it. I have created the dummy file by the process you described above. https://drive.google.com/drive/folders/1gwV6UwB44zq042pa6jmwlKZIANvKgTXV?usp=sharing

NirutaDhimal avatar Oct 06 '22 05:10 NirutaDhimal

Thank you @NirutaDhimal ! It's after midnight here, but I should be able to debug this (and get back to you) later tomorrow. Stay tuned!

vsoch avatar Oct 06 '22 06:10 vsoch

okay I think I see the cleaning is working? Are you saving? I am using your files in my PWD.


from deid.dicom import DicomCleaner
import os

client = DicomCleaner(deid='deid.dicom')
client = DicomCleaner(output_folder=os.getcwd())

client.detect('dummy.dcm')
{'flagged': True,
 'results': [{'reason': 'and Modality contains CT Manufacturer contains GE Rows equals 1024 BurnedInAnnotation contains YES',
   'group': 'graylist',
   'coordinates': [[0, '0,0,300,150'], [0, '724,0,300,150']]},
  {'reason': 'and Manufacturer contains GE Modality contains CT ManufacturerModelName contains GE|Stanford SeriesDescription contains Dose or ImageType contains SCREEN SAVE',
   'group': 'graylist',
   'coordinates': [[0, '0,0,512,121']]},
  {'reason': 'and Modality contains CT|MR ImageType contains DERIVED|SECONDARY|SCREEN|SAVE',
   'group': 'blacklist',
   'coordinates': []}]}
client.clean()
# This is needed to save the cleaned image - the original won't be touched
client.save_dicom()

And then the image I see there is a clear change. Here is the original:

image

And changed:

image

vsoch avatar Oct 06 '22 17:10 vsoch

@vsoch only one coordinates were removed from the dummy example when I tried it. This is my code ss1 and this is the result ss2

NirutaDhimal avatar Oct 08 '22 02:10 NirutaDhimal

Something is different between what you and I are doing because my results lists has three entries, and yours has one. Make sure you are using the master branch of deid and copying what I did exactly, and with the same file.

vsoch avatar Oct 08 '22 02:10 vsoch

I installed deid using pip and I am working on the same file. I try to copy what you exactly did

NirutaDhimal avatar Oct 08 '22 03:10 NirutaDhimal

Could it be that I used the default deid.dicom config and it covers the locations? Or should it have covered the top left?

vsoch avatar Oct 08 '22 03:10 vsoch

Given your coordinates, it should have covered the top left and top right. Which deid.dicom file did you use? I haven't specified any group for this in the deid.dicom

{'reason': 'and Manufacturer contains GE Modality contains CT ManufacturerModelName contains GE|Stanford SeriesDescription contains Dose or ImageType contains SCREEN SAVE', 'group': 'graylist', 'coordinates': [[0, '0,0,512,121']]}, {'reason': 'and Modality contains CT|MR ImageType contains DERIVED|SECONDARY|SCREEN|SAVE', 'group': 'blacklist', 'coordinates': []}]} Is this by default?

NirutaDhimal avatar Oct 08 '22 03:10 NirutaDhimal

Yes! So if the user doesn’t provide a custom recipe, we use this default, which is packaged with deid in the data folder. It seems that the headers in your dicom file triggered some of the default locations, but perhaps we are missing the top left? Should we try adding it? And where did you derive your metadata and coordinates from?

vsoch avatar Oct 08 '22 03:10 vsoch

I copied your code and this what I am getting. ss3 aa3

But I gave the the custom recipe. I used dcmdump on my original dcm file and derived the metadata and for coordinates I used itksnap to get them as there were texts on these coordinates in the original file and I wanted to remove them

NirutaDhimal avatar Oct 08 '22 03:10 NirutaDhimal

It's supposed to remove on top left and top right

NirutaDhimal avatar Oct 08 '22 03:10 NirutaDhimal

Ah ok so our viewers are flipped!

What I'm seeing is that:

  1. our viewers are flipped (I used the papaya viewer online, and those sections were on the right for me)
  2. the default deid.dicom encompasses one of the sections you are interested in, and an additional one you didn't target.
  3. the third section coodinates are still missing.

Now that I understand there should be another box on the other side, let me take a look again at the dummy data you sent and see if I can make sense of it. Back in a bit!

vsoch avatar Oct 08 '22 03:10 vsoch

ok thanks for helping me

NirutaDhimal avatar Oct 08 '22 03:10 NirutaDhimal

I used weasis viewer.

NirutaDhimal avatar Oct 08 '22 04:10 NirutaDhimal

Quick question - how did you derive the second coordinate? The image is 1024 by 1024, and the coordinate format is two mins followed by two maxes, so if you expect it to blank out the top right I would have expected the mins to be smaller than the maxes. What appears to be happening is that you are "selecting" a box of empty pixels.

vsoch avatar Oct 08 '22 04:10 vsoch

Okay so here is an example where I've adjusted your coordinates. There is probably a better way to describe it, but what I'm doing is shuffling around your coordinates so min values < max values, and extending the box to span your image (and remember my viewer is flipped). Trying to put this into human terms, I changed your recipe to:

FORMAT dicom

 %filter graylist

LABEL ANNOTATIONS
    contains Modality CT
    + contains ConversionType WSD
    + contains Manufacturer GE
    + contains ImageType MIP
    + contains ManufacturerModelName Revolution 
    + contains SoftwareVersions taix_bj.84.i386
    + contains Rows 1024
    + contains Columns 1024
    coordinates 1,12,227,195
    coordinates 271,9,1024,118 
                      # minr, minc, maxr, maxc
                      # indexed in the data like mask[minc:maxc, minr:maxr]
                      # those values are set to 0 to "blank" them
%header
ADD PatientIdentityRemoved YES
REPLACE PatientID var:id 
REPLACE SOPInstanceUID var:source_id

So from the above, if either of the max values is less than a min, that's an index that will silently error (giving you an empty array). So for example, if I adjust your values to the above I get:

image

So from what I can tell, the issue here is that the coordinate is wrong. The only reason we got two boxes on my first try is that I erroneously used the default deid.dicom recipe, and not the one you supplied. So if you derived these on your own, make sure they are in that format I've shown above, and that supplying the values actually produces boxes (the first one did not, the second box was an empty array).

vsoch avatar Oct 08 '22 04:10 vsoch

coordinates are in this format (x,y,w,h) right? My second ccordinate is (737, 9, 271, 118) which means the bottom right of the bounding box is has pixel (1108,127) both of which are less than 1024

NirutaDhimal avatar Oct 08 '22 04:10 NirutaDhimal

We follow the same convention as CTP: https://mircwiki.rsna.org/index.php?title=The_CTP_DICOM_Pixel_Anonymizer and you can see our original discussion here: https://gist.github.com/vsoch/df6957be12c34e62b21000603f1687e5 and documentation of it here: https://github.com/pydicom/deid/blob/27d46bb8851952fc3c6639d4675e254907085af7/deid/dicom/pixels/detect.py#L271-L282

Based on this logic, you have an index 737:271 which doesn't make sense. So either we fudged the logic in the cleaner, or the coordinate needs to be adjusted.

Pinging @fimafurman and @wetzelj in case I'm missing something - I've been away from imaging a long time and don't trust myself.

vsoch avatar Oct 08 '22 04:10 vsoch

I edited the format in which you specified and it worked. ss4 But I followed the CTP convention. It's (x, y, w, h) where w, h is the width and height of the bounding box. ss5 Thanks for helping me and giving your time :)

NirutaDhimal avatar Oct 08 '22 04:10 NirutaDhimal