Difference between revisions of "CRUISE/software/docs"
Jump to navigation
Jump to search
(Replaced 'I would like to put a couple of lines of space here') |
|||
| (12 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <meta name="title" content="CRUISE Control Documentation"/> | + | <!-- <meta name="title" content="CRUISE Control Documentation"/> --> |
{{h2|CRUISE Control Documentation}} | {{h2|CRUISE Control Documentation}} | ||
{{h3|CRUISE quick-start guide}} | {{h3|CRUISE quick-start guide}} | ||
| + | |||
| + | Install the | ||
{| | {| | ||
|valign="top"|1. | |valign="top"|1. | ||
| − | |valign="top"|Open [http://mipav.cit.nih.gov/ MIPAV v4.1.2] and check the '''Plugins''' menu to ensure that the CRUISE plugin has been installed ([http://medic.rad.jhmi.edu/download/ MedIC Downloads]). | + | |valign="top"|Open [http://mipav.cit.nih.gov/ MIPAV v4.1.2] and check the '''Plugins''' menu to ensure that the CRUISE plugin has been installed ([http://medic.rad.jhmi.edu/download/ MedIC Downloads]). If not yet installed, install iacl-plugins.jar and maps4mipav.jar like a standard plugin. |
|- | |- | ||
|valign="top"|2. | |valign="top"|2. | ||
| Line 88: | Line 90: | ||
|valign="top"|[[Image:CRUISEimage14.jpg|right|thumb|100px|3d surface view]] | |valign="top"|[[Image:CRUISEimage14.jpg|right|thumb|100px|3d surface view]] | ||
|- | |- | ||
| − | | | + | |style="padding: 20px; " | |
| − | | | + | |- |
| + | |} | ||
| + | |||
| + | {{h3|Using the Volume Converter Plugin in MIPAV}} | ||
| + | {| | ||
| + | |- | ||
| + | To view individual slices with nested surfaces, it is necessary to use the '''Volume Converter''' plugin in MIPAV. | ||
| + | |style="padding: 20px; " | | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|1. |
|valign="top"|Open MIPAV and your source image, and go to the '''Volume Converter''' plugin. | |valign="top"|Open MIPAV and your source image, and go to the '''Volume Converter''' plugin. | ||
|valign="top"|[[Image:CRUISEimage15.jpg|right|thumb|100px|Volume Converter]] | |valign="top"|[[Image:CRUISEimage15.jpg|right|thumb|100px|Volume Converter]] | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|2. |
|valign="top"|Under the '''Volume''' area of the interface, use the drop-down menu to choose your source image. If you want to open another image, you may do so using the '''Browse''' button. | |valign="top"|Under the '''Volume''' area of the interface, use the drop-down menu to choose your source image. If you want to open another image, you may do so using the '''Browse''' button. | ||
|valign="top"|[[Image:CRUISEimage16.jpg|right|thumb|100px|Select source image]] | |valign="top"|[[Image:CRUISEimage16.jpg|right|thumb|100px|Select source image]] | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|3. |
|valign="top"|Use the drop-down menu under '''File Type''' to select the type of output file you wish to generate. In this case, you should choose '''vtk''', which is all the way at the bottom of the option list. | |valign="top"|Use the drop-down menu under '''File Type''' to select the type of output file you wish to generate. In this case, you should choose '''vtk''', which is all the way at the bottom of the option list. | ||
|valign="top"|[[Image:CRUISEimage17.jpg|right|thumb|100px|Select File Type]] | |valign="top"|[[Image:CRUISEimage17.jpg|right|thumb|100px|Select File Type]] | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|4. |
|valign="top"|Press the '''OK''' button at the bottom of the interface. Next, you will be required to input a target directory for saving the output file. When you have selected this directory, press the '''Save''' button. | |valign="top"|Press the '''OK''' button at the bottom of the interface. Next, you will be required to input a target directory for saving the output file. When you have selected this directory, press the '''Save''' button. | ||
|valign="top"|[[Image:CRUISEimage18.jpg|right|thumb|100px|Select output directory]] | |valign="top"|[[Image:CRUISEimage18.jpg|right|thumb|100px|Select output directory]] | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|5. |
|valign="top"|A box will appear when the plugin has finished converting your source image to a vtk file. | |valign="top"|A box will appear when the plugin has finished converting your source image to a vtk file. | ||
|valign="top"|[[Image:CRUISEimage19.jpg|right|thumb|100px|Conversion is complete]] | |valign="top"|[[Image:CRUISEimage19.jpg|right|thumb|100px|Conversion is complete]] | ||
|- | |- | ||
| − | |valign="top"| | + | |style="padding: 20px; " | |
| + | |- | ||
| + | |} | ||
| + | |||
| + | {{h3|Viewing Nested Surfaces in Paraview}} | ||
| + | {| | ||
| + | |valign="top"|1. | ||
|valign="top"|Open Paraview. | |valign="top"|Open Paraview. | ||
|valign="top"|[[Image:CRUISEimage11.jpg|right|thumb|100px|Paraview]] | |valign="top"|[[Image:CRUISEimage11.jpg|right|thumb|100px|Paraview]] | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|2. |
|valign="top"|Use the '''File''' menu to browse to the output folder for the '''Volume Converter''', which will be named '''volconvert'''. | |valign="top"|Use the '''File''' menu to browse to the output folder for the '''Volume Converter''', which will be named '''volconvert'''. | ||
|valign="top"|[[Image:CRUISEimage20.jpg|right|thumb|100px|Volume Converter output folder]] | |valign="top"|[[Image:CRUISEimage20.jpg|right|thumb|100px|Volume Converter output folder]] | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|3. |
|valign="top"|Select the .vtk file inside the '''volconvert''' folder and press the '''OK''' button. | |valign="top"|Select the .vtk file inside the '''volconvert''' folder and press the '''OK''' button. | ||
|valign="top"|[[Image:CRUISEimage21.jpg|right|thumb|100px|Select .vtk file]] | |valign="top"|[[Image:CRUISEimage21.jpg|right|thumb|100px|Select .vtk file]] | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|4. |
|valign="top"|Your selected .vtk file will be visible in the upper left side of the Paraview interface. | |valign="top"|Your selected .vtk file will be visible in the upper left side of the Paraview interface. | ||
|valign="top"|[[Image:CRUISEimage22.jpg|right|thumb|100px|.vtk file loaded]] | |valign="top"|[[Image:CRUISEimage22.jpg|right|thumb|100px|.vtk file loaded]] | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|5. |
|valign="top"|On the lower left side of the interface, click on the '''Display''' tab. Scroll down to the '''Style''' section, and use the menu to the right of '''Representation''' to '''Volume'''. | |valign="top"|On the lower left side of the interface, click on the '''Display''' tab. Scroll down to the '''Style''' section, and use the menu to the right of '''Representation''' to '''Volume'''. | ||
|valign="top"|[[Image:CRUISEimage23.jpg|right|thumb|100px|Volume display]] | |valign="top"|[[Image:CRUISEimage23.jpg|right|thumb|100px|Volume display]] | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|6. |
|valign="top"|Scroll up in the '''Display''' tab to the '''Color''' area. Click on the '''Edit Color Map''' button. | |valign="top"|Scroll up in the '''Display''' tab to the '''Color''' area. Click on the '''Edit Color Map''' button. | ||
|valign="top"|[[Image:CRUISEimage24.jpg|right|thumb|100px|Edit Color Map]] | |valign="top"|[[Image:CRUISEimage24.jpg|right|thumb|100px|Edit Color Map]] | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|7. |
|valign="top"|Click on the '''Choose Preset''' button to bring up the preset color range selector. You will probably want to choose to have your image represented in '''Grayscale'''. | |valign="top"|Click on the '''Choose Preset''' button to bring up the preset color range selector. You will probably want to choose to have your image represented in '''Grayscale'''. | ||
|valign="top"|[[Image:CRUISEimage25.jpg|right|thumb|100px|Preset Color Scales]] | |valign="top"|[[Image:CRUISEimage25.jpg|right|thumb|100px|Preset Color Scales]] | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|8. |
|valign="top"|If you choose the '''Grayscale''' preset, you may want to adjust the color scale to get a better contrast. When you are happy with the contrast, click on the '''Close''' button. | |valign="top"|If you choose the '''Grayscale''' preset, you may want to adjust the color scale to get a better contrast. When you are happy with the contrast, click on the '''Close''' button. | ||
| | | | ||
| Line 147: | Line 162: | ||
|} | |} | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|9. |
|valign="top"|Use the '''File''' menu to browse to the outer surface vtk file. Press the '''OK''' button once you have selected the file. Once it is loaded in Paraview, press the '''Apply''' button. | |valign="top"|Use the '''File''' menu to browse to the outer surface vtk file. Press the '''OK''' button once you have selected the file. Once it is loaded in Paraview, press the '''Apply''' button. | ||
|valign="top"|[[Image:CRUISEimage28.jpg|right|thumb|100px|Load outer surface file]] | |valign="top"|[[Image:CRUISEimage28.jpg|right|thumb|100px|Load outer surface file]] | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|10. |
|valign="top"|Use the '''File''' menu to browse to the inner surface vtk file. Press the '''OK''' button once you have selected the file. Once it is loaded in Paraview, press the '''Apply''' button. | |valign="top"|Use the '''File''' menu to browse to the inner surface vtk file. Press the '''OK''' button once you have selected the file. Once it is loaded in Paraview, press the '''Apply''' button. | ||
|valign="top"|[[Image:CRUISEimage29.jpg|right|thumb|100px|Load inner surface file]] | |valign="top"|[[Image:CRUISEimage29.jpg|right|thumb|100px|Load inner surface file]] | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|11. |
|valign="top"|Once the surface files are loaded, click on the '''Group Datasets''' icon, which is the second button from the right on the toolbar immediately above the upper left side window containing the loaded filenames (this icon is marked with a red circle on the '''Group Datasets''' image). After you have clicked on this icon, press the '''Apply''' button. | |valign="top"|Once the surface files are loaded, click on the '''Group Datasets''' icon, which is the second button from the right on the toolbar immediately above the upper left side window containing the loaded filenames (this icon is marked with a red circle on the '''Group Datasets''' image). After you have clicked on this icon, press the '''Apply''' button. | ||
| | | | ||
| Line 163: | Line 178: | ||
|} | |} | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|12. |
|valign="top"|Next, locate the '''Cut''' icon. This is the fourth button from the left on the toolbar immediately above the upper left side window containing the loaded filenames (this icon is marked with a red circle on the '''Cut''' image). Press the '''Apply''' button after using the '''Cut''' tool. | |valign="top"|Next, locate the '''Cut''' icon. This is the fourth button from the left on the toolbar immediately above the upper left side window containing the loaded filenames (this icon is marked with a red circle on the '''Cut''' image). Press the '''Apply''' button after using the '''Cut''' tool. | ||
|valign="top"|[[Image:CRUISEimage33.jpg|right|thumb|100px|'''Cut''']] | |valign="top"|[[Image:CRUISEimage33.jpg|right|thumb|100px|'''Cut''']] | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|13. |
|valign="top"|Go to the '''Properties''' tab and locate the '''Normal''' subsection of the '''Slice Type: Plane''' area. Modify these values according to the acquisition orientation of your source image. For example, if you have used an axial image, change to values in the '''Normal''' section to 0,0,1. | |valign="top"|Go to the '''Properties''' tab and locate the '''Normal''' subsection of the '''Slice Type: Plane''' area. Modify these values according to the acquisition orientation of your source image. For example, if you have used an axial image, change to values in the '''Normal''' section to 0,0,1. | ||
|valign="top"|[[Image:CRUISEimage34.jpg|right|thumb|100px|Reset orientation]] | |valign="top"|[[Image:CRUISEimage34.jpg|right|thumb|100px|Reset orientation]] | ||
|- | |- | ||
| + | |} | ||
| + | |||
| + | {{h3|Viewing Labeled Surfaces in Paraview}} | ||
| + | {| | ||
| + | |valign="top"|1. | ||
| + | |valign="top"|Label your CRUISE surface. There are many ways to do this. A brief overview can be found [[Labeling Surfaces | here]]. | ||
| + | |- | ||
| + | |valign="top"|2. | ||
| + | |valign="top"|Open Paraview. | ||
| + | |valign="top"|[[Image:CRUISEimage11.jpg|right|thumb|100px|Paraview]] | ||
| + | |- | ||
| + | |valign="top"|3. | ||
| + | |valign="top"|It is often useful to change the look-up-table (LUT) used to color the surface. To do this, scroll up in the '''Display''' tab to the '''Color''' area. Click on the '''Edit Color Map''' button. | ||
| + | |valign="top"|[[Image:CRUISEimage24.jpg|right|thumb|100px|Edit Color Map]] | ||
| + | |- | ||
| + | |valign="top"|4. | ||
| + | |valign="top"|Click on the '''Choose Preset''' button to bring up the preset color range selector. Select the '''Import''' option to choose a custom Color Scale. | ||
| + | |valign="top"|[[Image:CRUISEimage25.jpg|right|thumb|100px|Preset Color Scales]] | ||
| + | |- | ||
| + | |valign="top"|5. | ||
| + | |valign="top"|Paraview color scales are stored as .xml files. A good choice for surfaces with discrete labels is the striped Color Scale, and xml file for which can be found [[ParaviewStripedLUT | here]]. Click '''Ok''' to choose a custom color scale | ||
| + | |valign="top"|[[Image:StripedLUT.JPG|right|thumb|100px|Paraview Striped LUT]] | ||
| + | |- | ||
| + | |valign="top"|6. | ||
| + | |valign="top"|Select the Color Scale you would like from the menu, and click '''Ok'''. Click '''Close''' to exit the color scale editor. Your labeled surface should now have a different color for every label. | ||
| + | |valign="top"|[[Image:CRUISELabeledSurfaceStriped.JPG|right|thumb|100px|Labeled CRUISE Surface]] | ||
| + | |- | ||
| + | |} | ||
| + | |||
| + | {{h3|Creating Animations in Paraview}} | ||
| + | {| | ||
| + | |valign="top"|1. | ||
| + | |valign="top"|Here we will briefly walk through the steps in creating a simple animation in Paraview. The example shown will create an animation showing axial cuts of a cortical surface for a number of axial slices. | ||
| + | |- | ||
| + | |valign="top"|2. | ||
| + | |valign="top"|Open Paraview and load the surfaces or volumes you would like to animate. | ||
| + | |valign="top"|[[Image:Pv_anim1.jpg|right|thumb|100px|Paraview]] | ||
| + | |- | ||
| + | |valign="top"|3. | ||
| + | |valign="top"|Use Paraview's tools to create the visualization you would like. Here, we took an axial slice through an inner cortical surface. | ||
| + | |valign="top"|[[Image:Pv_anim2.jpg|right|thumb|100px|Edit Color Map]] | ||
| + | |- | ||
| + | |valign="top"|4. | ||
| + | |valign="top"|Click View > Animation Inspector to open the Animation Inspector. Under 'Track Selection' change the 'Selected Object', and 'Propery To Animate' drop down menus to select the objects and properties you would like to animate. In this example, we would like the plane which cuts the surface to move in the z direction. We choose 'Slice2' as our selected object, and 'Slice Type - Origin(2)' which refers to the slice plane's z-coordinate as the 'Propery To Animate'. | ||
| + | |valign="top"|[[Image:Pv_anim3.jpg|right|thumb|100px|Preset Color Scales]] | ||
| + | |- | ||
| + | |valign="top"|5. | ||
| + | |valign="top"|Next, we need to specify the keyframes for our animation. In this example we will need two keyframes. In the 'Animation Inspector' scroll down to the 'Key Frame Editor' and click on 'Add Key Frame' once. You will see that the key frame options are now active. Change the 'Key Frame Value' to the value you would like the 'Property to Animate' to take at time=0. We chose a value of 50 for our axial slice. Click the up arrow to the right of 'Key Frame Index' to edit the parameters for the second key frame. We chose a value of 135 for our axial slice. | ||
| + | |valign="top"|[[Image:Pv_anim4.jpg|right|thumb|100px|Paraview Striped LUT]] | ||
| + | |- | ||
| + | |valign="top"|6. | ||
| + | |valign="top"|To bring up an overview of the current animation, click View>Animation View. This should open a panel showing the objects and properties currently being animated. In our example, Slice2 - Slice Type - Origin(2) is being animated. Double clicking the object name will open a window as shown in the figure to the right. It shows that this objects properties start at 50 and end at 135. Also displayed is the interpolation. The default, ramp, creates a linear change in the property with time. | ||
| + | |valign="top"|[[Image:Pv_anim5.jpg|right|thumb|100px|Animation keyframes]] | ||
| + | |- | ||
| + | |valign="top"|7. | ||
| + | |valign="top"|Close the Animation Keyframes window. Again in the Animation Inspector, change play mode to 'Real Time'. This allows you to specify the duration of the animation. Choosing 'Sequence' allows you to specify the number of frames in the animation. Once this is done select File>Save Animation and specify the framerate, duration, and resolution of the animation. When you are finished, click ok. Note: Paraview may automatically change the resolution of the animation depending on your settings. | ||
| + | |valign="top"|[[Image:Pv_anim6.jpg|right|thumb|100px|Animation settings]] | ||
| + | |- | ||
| + | |} | ||
Latest revision as of 00:48, 3 July 2022
CRUISE Control Documentation
CRUISE quick-start guide
Install the
| 1. | Open MIPAV v4.1.2 and check the Plugins menu to ensure that the CRUISE plugin has been installed (MedIC Downloads). If not yet installed, install iacl-plugins.jar and maps4mipav.jar like a standard plugin. | |||
| 2. | Open a stripped image, then open the CRUISE plugin. The interface will automatically open to the TOADS 2007 tab. | |||
| 3. | In the drop-down menu in the Image to segment section, choose the image you want to work with. The list provided here will include any images you currently have open. If you want to open another image, you may either open it through the MIPAV file menu or browse to the image within the CRUISE interface using the Browse button under the Image to segment area. | |||
| 4. | Under Image modality, make sure the proper type of image is selected. | |||
| 5. | Under Atlas file, input the path for the template you wish to use. You may use the text file from the TOADS atlas to begin with [1], or input another atlas text file of your choice. | |||
| 6. | Modify any other parameters you wish to change (link to extended guide). You should be able to get a decent result without changing any other options. | |||
| 7. | Click on the OK button at the base of the plugin interface to begin processing. A window will pop up in which you may indicate where you want to save the output files. Once you have chosen a location, press the Save button in this window, and the processing will begin. |
| ||
| 8. | You will immediately see a very large jump in memory use by MIPAV. If you have enough memory that is not allocated to MIPAV, you may use your computer with the process running in the background. If you find your processes are lagging, leave your computer alone until the iterations are complete. | |||
| 9. | After processing has finished, there should be several output folders, all within a folder named cruise which will be in the same directory as your input file. These folders should include ace, crop, gvf, tgdm, Toads07, and topo_correct. Please see the extended guide for more information on the output files in each of these folders (link to extended guide). |
| ||
| 10. | To view a topological reconstruction of the extracted cortical surfaces, you may look at the files within the tgdm folder. |
CRUISE extended guide
| As soon as I have finished more of the extended guide, there will be a short description and link to it here.
Cortical surface viewing instructionsInstructions for viewing in MIPAV
|
