Particle Analysis Window and Copycvfields: Difference between pages

From Eigenvector Research Documentation Wiki
(Difference between pages)
Jump to navigation Jump to search
imported>Scott
 
imported>Donal
No edit summary
 
Line 1: Line 1:
The Particle Analysis window is an interface into the [[analyzeparticles]] function. Included in the interface are controls for adjusting settings for the particle analysis and exploring the results. Once the particle analysis is complete you can export the resulting image and or table to [[analysis]]. When an image is exported to analysis, the particles identified by Particle Analysis are identified in class-sets associated with each particle. One classset has a class for each particle. Pixels within particle j have class = j. Non particle pixels have class = 0. Second classset has one class for all particles. Pixels within any particle have class = 1. Non particle pixels have class = 0.
===Purpose===


==Interface==
Copy cross-validation results into model from structure.
The Particle Analysis interface has three main areas for the image, particle table, and analysis function settings. The basic workflow:
# Load image data.
# Adjust function settings.
# Run the particle analysis.
# Explore the results.
# Repeat steps 2-4 until you have the desired results.
# Save or export your results.  


===Synopsis===


[[Image:Particlegui.png|border|600px|Particle Analysis Interface]]
:model = copycvfeilds(from,to)


==Menu==
===Description===
* File
** Load Workspace Image - Load image data (numeric or DataSet) from the Workspace.
** Import Image - Load an image from a supported file [[Image_File_Readers |format]].
** Save Image - Save image to file or workspace.
** Save Table Data - Save particle table data to file or workspace.
** Clear Data - Clear image and particle table.
** Close - Close Particle Analysis window without saving data.
* Edit
** Particle GUI Options - Optional settings for Particle Analysis interface.
** Particle Analysis Options - Optional settings for the Particle Analysis function. Note that most of these settings are available in the Settings area of the window.
*Help
** Particle Analysis Help - Opens this page.
** PLS_Toolbox Help - Opens main help page for PLS_Toolbox.
==Toolbar==
From left to right in the image above the toolbar buttons are:
* Lambda - Opens the Workspace Browser.
* A/B Box - Open function options.
* Gears - Runs particle analysis using the current settings.
* Check Box - Toggles all the selected particles.
* Layers - Changes the background alpha color of the particles. Cycles through Black, White, and Red and can be used to enhance appearance of particles.
* Table Export - Export the particle table to [[analysis]].
* Image Export - Export the image to [[analysis]].
* Read X - Close the window without saving.


==Settings==
Given the output of the crossval function ('from', as either a structure or
a model with the expected fields in the detail sub-field) and a target
model, the fields associated with cross-validation results will be copied
over to the target model.
If the target model ('to') is omitted or is not a standard model structure,
the cross-validation fields in ('from') are copied directly to
corresponding fields in a flat structure.
Note: no assurance is made that the copied cross-validation results
actually correspond to the target model - user must assure the results apply to
the ('to') model.


====Inputs====


For a detailed explanation of the function setting see [[analyzeparticles]]. Additional settings can be found using Edit>Particle Analysis Options.
from = A structure or model with cross-validation fields in the detail sub-field.


==Image==
====Optional Inputs====
Depending on the settings, the image displays particles as regions masked with a semitransparent layer (alpha mask) either over each particle or over the non-particle region. The background color can be adjusted (using the toolbar button) to emphasize the regions.


==Particle Table==
None.
The Particle Table has two particle selection methods. First, you can check/uncheck particles in the Show column. This will turn on/off the particle as show by the alpha mask. You can also select the "row header" (integer row number). This will draw an outline around the particle (see image above).
 
====Outputs====
 
to = A model structure.
 
===Examples===
 
model = copycvfields(res, model);
 
copies crossval results ('res') to a model.
 
res = copycvfields(model);
 
copies crossval results from a model to a structure.
 
model_to = copycvfields(model_from,model_to);
 
copies crossval results from one model to another.
 
 
===See Also===
 
[[dataset/dataset]], [[modelstruct]], [[copydsfields]], [[crossval]]

Revision as of 00:44, 24 February 2011

Purpose

Copy cross-validation results into model from structure.

Synopsis

model = copycvfeilds(from,to)

Description

Given the output of the crossval function ('from', as either a structure or a model with the expected fields in the detail sub-field) and a target model, the fields associated with cross-validation results will be copied over to the target model. If the target model ('to') is omitted or is not a standard model structure, the cross-validation fields in ('from') are copied directly to corresponding fields in a flat structure. Note: no assurance is made that the copied cross-validation results actually correspond to the target model - user must assure the results apply to the ('to') model.

Inputs

from = A structure or model with cross-validation fields in the detail sub-field.

Optional Inputs

None.

Outputs

to = A model structure.

Examples

model = copycvfields(res, model);

copies crossval results ('res') to a model.

res = copycvfields(model);

copies crossval results from a model to a structure.

model_to = copycvfields(model_from,model_to);

copies crossval results from one model to another.


See Also

dataset/dataset, modelstruct, copydsfields, crossval