Changes between Version 60 and Version 61 of UvmatHelp


Ignore:
Timestamp:
Jun 11, 2013, 10:04:53 AM (7 years ago)
Author:
sommeria
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • UvmatHelp

    v60 v61  
    430430   * 'line': simple straight segment, defined by its two end points
    431431   * 'polyline': open line made of n-1 consecutive segments (defined by n points)
    432    * 'rectangle': defined by its center, half width and half height.
     432   * 'rectangle': defined by its center, half width and half height, and possibly angle of axis..
    433433   * 'polygon': closed line made of n consecutive segments (defined by n points)
    434    * 'ellipse': defined by its center, half width, half height, and Angle of axis with respect to 0x.
     434   * 'ellipse': defined by its center, half width, half height, and possibly angle of axis.
    435435   * 'plane': plane with associated cartesian coordinates
    436436   * 'volume': volume with associated cartesian coordinates
     
    438438 * ''' !ProjMode: ''': specifies the method of projection of coordinates and field, as described in [#a6.3Projectionmodes next sub-section].
    439439
    440  * ''' Angle: ''': three component rotation vector used to define the orientation, for instance for planes.
    441 
    442  * ''' RangeX: ''', ''' RangeY: ''', ''' RangeZ: ''':bounds defining the range of projection along each coordinate, one or two values depending on the object type.
     440 * ''' Angle: ''': three component rotation vector which defines the orientation of the object coordinate axis, for 'plane' and 'volume'. In 2D, this rotation vector has only one component along z, defining a rotation angle in the plane (expressed in degrees). This applies also to the main axis of 'ellipse' and 'rectangle'. In 3D, line objects ('line', 'polyline','rectangle','polygon','ellipse') are assumed contained in a plane, and 'Angle' defines the orientation of this plane.
     441   
     442 * ''' RangeX: ''', ''' RangeY: ''', ''' RangeZ: ''':bounds defining a range of projection along each coordinate with respect to the object. These ranges have one or two values depending on the object type.
     443    * 'points': the only relevant range is RangeX, with one value (a radius around the point).
     444    * 'lines': the only relevant range is RangeY, with one value, a radius transverse to the line.
     445    * 'polyline' and 'polygon' ranges are not relevant.
     446    * 'rectangle','ellipse': RangeX and RangeY (one value) define the half length and half width respectively. In 3D, RangeZ may set a range of projection transverse to the plane containing the object.
     447    * 'plane': RangeX and RangeY (two values each) may restrict a region in the coordinates of the plane. In 3D, RangeZ may set a range of projection transverse to the plane.
     448    * 'volume': RangeX, RangeY, rangeZ (two values each) define a selected volume in the data set.
    443449
    444450 * ''' DX: ''', ''' DY: ''', ''' DZ: ''':mesh  along each coordinate defining a grid for interpolation.
     
    449455   * for 'plane' or 'volume': coordinates of the origin of the new coordinate frame attached to the object.
    450456
    451  * ''' CoordUnit: ''' units for the coordinates, must fit with the units of coordinates for the projected field.
     457 * ''' !CoordUnit: ''' units for the coordinates, must fit with the units of coordinates for the projected field.
    452458
    453459=== 6.3 Projection modes ===
     
    455461
    456462 * ''' !ProjMode = 'projection':  '''  this is a normal projection  of the field data in a range of action around the object, as defined by the parameters 'RangeX', 'RangeY', "RangeZ'. The projection of an input variable defined on unstructured coordinates therefore remains unstructured. By contrast, an input variable defined on a regular grid always yields a projected variable on a regular grid (for instance on a line or plane). Error flags ?
    457    * 'points': each field variable is averaged in a sphere of radius RangeX (a single value) around each projection point and attributed to this point position.
    458    * 'line': for scattered coordinates, each initial data point within a range ''RangeY'' on each side of the line is normally projected on the line, keeping its field values. For grid lin interpolation and averaging.  Vector quantities are furthermore projected on the line as longitudinal (X) and normal (Y) components. RangeX, with two values, can be used to set bounds along the axis.
    459    * 'plane': similar as line, RangeZ in 3D. RangeX and RangeY used to set bounds.
    460    * 'volume': used to set bounds in 3D within a box [RangeX, RangeY, RangeZ].
     463   * 'points': each field variable is averaged in a sphere of radius RangeX (a single value) around each projection point and attributed to this point position. An ancillary variable U_nbval(i) indicates the number of (non-false) data found around each point. Ancillary data and warning flags are not projected on points. 
     464   * 'line': for scattered coordinates, each initial data point within a range ''RangeY'' on each side of the line is normally projected on the line, keeping its field values. For grid lin interpolation and averaging.  Vector quantities are furthermore projected on the line as longitudinal (X) and normal (Y) components. The line length and mean value of each variable along the line is also calculated (giving access to circulation and flux). Ancillary data and warning flags are not projected on points.
     465   * 'plane': similar as line, RangeZ in 3D. RangeX and RangeY used to set bounds. All data are projected in this mode.
     466   * 'volume': used to set bounds in 3D within a box [RangeX, RangeY, RangeZ].  All data are projected in this mode.
    461467   *  no action on 'polyline', 'rectangle', 'polygon', 'ellipse'.
    462468
    463469 * ''' !ProjMode 'interp_lin': '''  Linear interpolation of scalar and vector field variables, after exclusion of false data (marqued by error flag). Ancillary data and warning flags are not projected in this mode. Gridded data are interpolated by ..., while fields with scattered coordinates are projected with the Matlab function .... Note that this function provides interpolation only within the convex hull of the initial data set, attributing 'NaN' (undefined) field values out of this domain. To avoid problems with further data processing, uvmat transforms NaN values into zeros, but mark them with an error flag FF=1.
    464470   * 'points': linear interpolation on each point of the object.
    465    * 'line','polyline', 'rectangle', 'polygon', 'ellipse': linear interpolation on points regularly spaced on the line, with mesh DX. The X coordinate is the distance following the line, with an origin at the starting point(the first point in 'line','polyline','polygon',the lower left corner for rectangle, the point along the main axis for an ellipse).
     471   * 'line','polyline', 'rectangle', 'polygon', 'ellipse': linear interpolation on points regularly spaced on the line, with mesh DX. The X coordinate is the distance following the line, with an origin at the starting point(the first point in 'line','polyline','polygon',the lower left corner for rectangle, the point along the main axis for an ellipse). The line length and mean value of each variable along the line is also calculated (giving access to circulation and flux).
    466472   * 'plane': linear interpolation on a regular grid with meshes DX, DY and ortigin at (X,Y)=(0,0). This grid is bounded by the two values of RangeX and RangeY along X and Y respectively.
    467473 
    468474 * ''' !ProjMode  'interp_tps':  '''  This behaves with different objects line 'interp_lin', but using the more precise thin spline shell method. This is particularly usefull to calculate spâtial field derivatives. Furthermore this method provides data exrtrapolation outside the initial convex hull (although it is not reliable at large distances). This mode does require a previous calculation of tps weights, see [#a5.1Gridingofdata section 5.1], so it does not act on the initial field cells with scattered coordinates. This is done by uvmat if tps projection is requested. Gridded data are linearly interpolated (to clarify...).
    469475
    470  * ''' !ProjMode 'inside' and 'ouside '''': defined only for closed lines: rectangle, polygon, ellipse. For each field U, its probability distribution function Uhist  inside, or respectively outside,  the line is calculated, as well as the mean Umean.
     476 * ''' !ProjMode 'inside' and 'ouside '''': defined only for closed lines: rectangle, polygon, ellipse. For each field U, its probability distribution function Uhist  inside, or respectively outside,  the line is calculated, as well as the mean Umean. other statistics...
    471477
    472478 * ''' !ProjMode 'none', 'mask_inside', 'mask_outside': ''' no projection operation. The object is used solely for plotting purpose, to show a boundary or to prepare a mask, inside or outside a closed line, see [#a9-Masksandgrids section 9]).
     
    474480Operations, for instance 'vort', 'div' are performed after interpolation. Similarly for field difference, which requires interpolation to compare fields defined at different positions. Field variables to be substracted are initially marqued by an attribute 'CheckSub'. 
    475481
    476 === 6.4 Projected fields ===
    477 The result of projection can be easily checked by creating the object in uvmat, and using the menubar option '''[Export/field in workspace]'''  in '''view_field.fig'''.
    478 
    479  * ''' Projection on n points:  '''   for each variable U, a set of n values U(i),i=1 to n is obtained, together with the unstructured coordinates (X(i), Y(i)) of the n points, and Z(i) in 3D.
    480    * !ProjMode= 'projection': the value U(i) is obtained as an average of the (non false) data values in a domain  of sizes max(2RangeX, 2RangeY, 2RangeZ) centered at each projection point. An ancillary data U_nbval(i) is also obtained, indicating the number of non-false data around each point.
    481    * !ProjMode= 'interp_lin':   U(i),i=1 is obtained as a linear interpolation on each point.
    482 
    483  * ''' Projection on open lines: '''   This includes the object styles 'line', 'polyline'. For vector fields, the projected  x component is along the line and the y component is perpendicular. 3D case still needs to be implemented**.
    484    * !ProjMode='projection': in the case of unstructured coordinates, each data point in the region of action (width max(RangeY) around the line) is projected onto the line. The direction of projection is normal except if 'Phi' is non equal to 0 (only possible for 'line'). For structured coordinates with meshes DX,DY (DZ),  data are interpolated on the line with a mesh =min(DX,DY,DZ). For each field component U, a corresponding projected field U is produced. If DX is defined on the line, a smoothed field U_smooth is also calculated, as well as the mean U_mean along the line.
    485    * !ProjMode='interp_lin': non-false data are linearly interpolated on the line, with mesh =DX along the line. Data which are 'discrete','warnflag' or 'errorflag' (as defined by the attribute 'Role') are not projected.
    486 
    487  * ProjMode='interp_tps': same as 'interp' but with a smoothing operation.
    488 
    489  * ''' Projection on closed lines: '''  , This includes 'rectangle','ellipse','polygon'. For ProjMode='projection', 'interp', 'filter', it behaves like open lines (not all options implemented yet**). For ProjMode='inside' or 'outside', the pdf of each field variable, restricted to the inside or the outside respectively,  is calculated.
    490 
    491  * ''' Projection on planes:  ''' Data in the range of action (RangeZ on each side of the plane) are projected normally to the plane, and its position expressed with respect to the coordinate system attached to the plane. This coordinate system is defined by an origin, the plane position XObject,YObject, ZObject, the ranges [RangeX(1) RangeX(2)]  and [RangeY(1) RangeY(2)] for X and Y, and the Euler angles Phi, Theta, Psi.
    492    * !ProjMode='projection': in the case of unstructured coordinates, all field variables are projected onto the plane.  For structured coordinates with meshes DX,DY (DZ),  data are interpolated on the line with a mesh =min(DX,DY,DZ).
    493    * !ProjMode='interp_lin': non-false data are linearly interpolated on the grid defined by the plane coordinate system and and meshes DX, DY. Data which are 'discrete','warnflag' or 'errorflag' (as defined by the attribute 'Role') are not projected.
    494    * !ProjMode='interp_tps': same as interp_lin but with thin plate shell interpolation.
    495 
    496  * ''' Projection on volumes:**  ''' This is used to delimitate a volume for 3D representation
    497 
    498 === 6.5 Object representation ===
     482
     483=== 6.4 Object representation ===
    499484Projections objects are drawn in magenta color when they are selected for creation or edition, and in blue otherwise.
    500485
     
    517502 * 'plane': plane with associated cartesian coordinates
    518503 * 'volume': volume with associated cartesian coordinates
    519 
    520 [<doc115|right>->#top]
    521504
    522505== 7- Netcdf files and the GUI get_field ==