Changeset 537 in Sophya


Ignore:
Timestamp:
Nov 2, 1999, 6:20:26 PM (26 years ago)
Author:
ercodmgr
Message:

Documentation PI - Reza 2/11/99

Location:
trunk/SophyaPI
Files:
16 edited

Legend:

Unmodified
Added
Removed

  • trunk/SophyaPI/PI/parradapter.cc

    r485 r537  
    1414// include      parradapter.h
    1515//
    16 //      Adaptateur de tableaux 1-D . La methode "Value(i)" doit etre redefinie
    17 //      dans une classe derivee.
    18 //
    19 //--
    20 //++
    21 // Links        Voir aussi
     16//      Adaptateur de tableaux 1-D . La méthode "Value(i)" doit être redéfinie
     17//      dans une classe dérivée.
     18//
     19//--
     20//++
     21// Links        Voir aussi
    2222// P2DArrayAdapter
    2323// P1DAdapter<T>
    … …  
    2525
    2626//++
    27 // Titre        Constructeur, méthodes
     27// Titre        Constructeur, méthodes
    2828//--
    2929//++
    … …  
    7272// include      parradapter.h
    7373//
    74 //      Adaptateur de tableaux 2-D . La methode "Value(i,j)" doit etre redefinie
    75 //      dans une classe derivee.
    76 //
    77 //--
    78 //++
    79 // Links        Voir aussi
     74//      Adaptateur de tableaux 2-D . La méthode "Value(i,j)" doit être redéfinie
     75//      dans une classe dérivée.
     76//
     77//--
     78//++
     79// Links        Voir aussi
    8080// P1DArrayAdapter
    8181// P2DAdapter<T>
    … …  
    8383
    8484//++
    85 // Titre        Constructeur, méthodes
     85// Titre        Constructeur, méthodes
    8686//--
    8787//++
    … …  
    447447// include      parradapter.h
    448448//
    449 //      Adaptateur de tableaux 1-D, construit a partir d'un pointeur
     449//      Adaptateur de tableaux 1-D, construit à partir d'un pointeur
    450450//      "T* data"
    451451//--
    452452//++
    453 // Links        Voir aussi
     453// Links        Voir aussi
    454454// P1DArrayAdapter
    455455// P2DAdapter<T>
    … …  
    457457
    458458//++
    459 // Titre        Constructeur
     459// Titre        Constructeur
    460460//--
    461461//++
    462462// P1DAdapter<T>(T* data, int sz, bool ad=false)
    463 //      Constructeur a partir d'un tableau "T* data", de taille "sz".
    464 //      Si "ad==true", le destructeur libere l'espace memoire de "data"
     463//      Constructeur à partir d'un tableau "T* data", de taille "sz".
     464//      Si "ad==true", le destructeur libere l'espace mémoire de "data"
    465465//      par delete.
    466466//--
    … …  
    475475//--
    476476//++
    477 // Links        Voir aussi
     477// Links        Voir aussi
    478478// P2DArrayAdapter
    479479// P1DAdapter<T>
    … …  
    481481
    482482//++
    483 // Titre        Constructeur
     483// Titre        Constructeur
    484484//--
    485485//++
    486486// P2DAdapter(T* data, int sx, int sy, bool ad=false)
    487 //      Constructeur a partir d'un pointeur "T* data", representant un
     487//      Constructeur à partir d'un pointeur "T* data", représentant un
    488488//      tableau 2D de taille "sx * sy".
    489 //      Si "ad==true", le destructeur libere l'espace memoire de "data"
     489//      Si "ad==true", le destructeur libere l'espace mémoire de "data"
    490490//      par delete.
    491491//--

  • trunk/SophyaPI/PI/picmapview.cc

    r535 r537  
    1313//--
    1414//++
    15 // Links        Voir aussi
     15// Links        Parents
     16// PIBaseWdg
     17//--
     18//++
     19// Links        Voir aussi
    1620// PIColorMap
    1721//--

  • trunk/SophyaPI/PI/pidrawer.cc

    r535 r537  
    557557/*  --------------------------------------------------------------  */
    558558
     559//++
     560// Class        PIElDrawer
     561// Lib          PI
     562// include      pidrawer.h
     563//
     564//      Classe de traceur ("Drawer") capable de gérer et de
     565//      tracer une liste d'éléments simples. Cette classe
     566//      est utilisé pour le tracé des axes et des éléments de
     567//      texte ds les "PIScDrawWdg", "PIDraw3DWdg" et "PIImage".
     568//--
     569//++
     570// Links        Parents
     571// PIDrawer
     572//--
     573
     574//++
     575// Titre        Constructeurs et méthodes
     576//--
     577
     578//++
     579// PIElDrawer()
     580//      Constructeur
     581//--
     582
    559583/* --Methode-- */
    560584PIElDrawer::PIElDrawer()
    … …  
    569593}
    570594
     595
     596//++
     597//  void  SetTitles(const char* tt=NULL, const char* tb=NULL)
     598//      Ajout de titres haut ("tt") et bas ("tb")
     599//  void  SetTitles(string const & tt, string const & tb)
     600//      Ajout de titres haut ("tt") et bas ("tb")
     601//--
     602
    571603/* --Methode-- */
    572604void PIElDrawer::SetTitles(const char* tt, const char* tb)
    … …  
    581613titleT = tt;  titleB = tb;
    582614}
     615
     616//++
     617// int  ElAddText(PIGrCoord x, PIGrCoord y, const char* s, PIColors c=PI_NotDefColor)
     618//      Ajout d'un élément texte avec un attribut de couleur.
     619//      Renvoie le numéro identificateur de l'élément.
     620// int  ElAddLine(PIGrCoord x1, PIGrCoord y1, PIGrCoord x2, PIGrCoord y2, -
     621//                 PIColors c=PI_NotDefColor)
     622//      Ajout d'un élément de ligne avec un attribut de couleur.
     623//      Renvoie le numéro identificateur de l'élément.
     624// int  ElAddRect(PIGrCoord x, PIGrCoord y, PIGrCoord dx, PIGrCoord dy, -
     625//                PIColors c=PI_NotDefColor)
     626//      Ajout d'un élément de type rectangle avec un attribut de couleur.
     627//      Renvoie le numéro identificateur de l'élément.
     628// int  ElAddFRect(PIGrCoord x, PIGrCoord y, PIGrCoord dx, PIGrCoord dy, -
     629//                PIColors c=PI_NotDefColor)
     630//      Ajout d'un élément de type rectangle plein avec un attribut de couleur.
     631//      Renvoie le numéro identificateur de l'élément.
     632// int  ElAddCirc(PIGrCoord x, PIGrCoord y, PIGrCoord r, PIColors c=PI_NotDefColor)
     633//      Ajout d'un élément de type cercle avec un attribut de couleur.
     634//      Renvoie le numéro identificateur de l'élément.
     635// int  ElAddFCirc(PIGrCoord x, PIGrCoord y, PIGrCoord r, PIColors c=PI_NotDefColor)
     636//      Ajout d'un élément de type cercle plein avec un attribut de couleur.
     637//      Renvoie le numéro identificateur de l'élément.
     638//
     639// void  ElDel(int id)
     640//      Suppression de l'élément avec l'identificateur "id".
     641// void  ElDelAll()
     642//      Suppression de tous les éléments du dessin.
     643//--
    583644
    584645/* --Methode-- */

  • trunk/SophyaPI/PI/pidrwtools.cc

    r505 r537  
    99#include "pi3ddrw.h"
    1010
     11//++
     12// Class        PIDrwTools
     13// Lib          PI
     14// include      pidrwtools.h
     15//
     16//      Classe de fenêtre de dialogue permettant de modifier interactivement
     17//      Les attributs graphique des "Drawer" attachés aux "PIBaseWdg".
     18//      Permet aussi de modifier les attributs d'axes pour les "PIScDrawWdg"
     19//--
     20// Links        Parents
     21// PIWindow
     22//--
     23//++
     24// Links        Voir aussi
     25// PIDrawer
     26// PIBaseWdg
     27//--
     28//++
     29// Links        Ainsi que
     30// PIScDrawWdg
     31// PIImage
     32// PIDraw3DWdg
     33//--
     34
     35//++
     36// Titre        Méthodes statiques
     37//--
     38//++
     39// void  ShowPIDrwTools()       
     40//      Méthode statique permettant l'affichage de la fenêtre de contrôle des
     41//      attributs graphiques des "Drawer". L'instance de la classe
     42//       "PIDrwTools" est créée si nécessaire.
     43// void  HidePIDrwTools()
     44//      Désacative (cache) la fenêtre "PIDrwTools" (méthode statique).
     45// void  SetCurrentBaseWdg(PIBaseWdgGen* cbw)
     46//      Méthode statique permettant de sélectionner le "PIBaseWdg" courant.
     47// PIBaseWdgGen*  GetCurrentBaseWdg()
     48//      Retourne le "PIBaseWdg" courant (méthode statique).
     49//--
     50
    1151
    1252PIDrwTools* PIDrwTools::cwdrwt = NULL;
    … …  
    1858if (cwdrwt == NULL)  cwdrwt = new PIDrwTools(PIApplicationGetApp());
    1959cwdrwt->Show();
     60}
     61
     62/* --Methode-- */
     63void PIDrwTools::HidePIDrwTools()
     64{
     65if (cwdrwt == NULL)  return;
     66cwdrwt->Hide();
    2067}
    2168

  • trunk/SophyaPI/PI/pidrwtools.h

    r505 r537  
    2626  static PIDrwTools* curlutw;
    2727  static void ShowPIDrwTools();
     28  static void HidePIDrwTools();
    2829  static void SetCurrentBaseWdg(PIBaseWdgGen* cbw);
    2930  static PIBaseWdgGen* GetCurrentBaseWdg();

  • trunk/SophyaPI/PI/pigraphuc.cc

    r535 r537  
    108108//|     kAxeDirDownUp : Axe Y croissant de Bas vers Haut
    109109//|     kAxeDirUpDown : Axe Y croissant de Haut vers Bas
    110 //|     kAxeDirAuto : Sens determine a partir de la valeur relative de xmin, xmax, ymin, ymax
    111 //|                   xmin < xmax : kAxeDirLtoR   -  xmax < xmin : kAxeDirRtoL
    112 //|                   ymin < ymax : kAxeDirDownUp -  ymax < ymin : kAxeDirUpDown
     110//|     kAxeDirAuto : Sens determine a partir de la valeur relative
     111//|     de xmin, xmax, ymin, ymax
     112//|           xmin < xmax : kAxeDirLtoR   -  xmax < xmin : kAxeDirRtoL
     113//|           ymin < ymax : kAxeDirDownUp -  ymax < ymin : kAxeDirUpDown
    113114//      Par défaut : "xmin=ymin=0." , "ymin=ymax=0." , "kAxeDirLtoR" , "kAxeDirDownUp"
    114115//

  • trunk/SophyaPI/PI/piimage.cc

    r535 r537  
    5151//--
    5252//++
    53 // Links        Voir aussi
     53// Links        Voir aussi
    5454// PIColorMap
    5555// P2DArrayAdapter
     56// PIImgTools
     57// PIDrwTools
    5658//--
    5759

  • trunk/SophyaPI/PI/piimgtools.cc

    r448 r537  
    88#include "piimage.h"
    99
     10//++
     11// Class        PIImgTools
     12// Lib          PI
     13// include      piimgtools.h
     14//
     15//      Classe de fenêtre de dialogue permettant de modifier interactivement
     16//      Les différents attributs de visualisation pour les *PIImage* .
     17//--
     18//++
     19// Links        Parents
     20// PIWindow
     21//--
     22//++
     23// Links        Voir aussi
     24// PIImage
     25//--
     26
     27//++
     28// Titre        Méthodes statiques
     29//--
     30//++
     31// void  ShowPIImgTools()       
     32//      Méthode statique permettant l'affichage de la fenêtre de contrôle des
     33//      paramètres de visualisation des images. L'instance de la classe
     34//       "PIImgTools" est créée si nécessaire.
     35// void  HidePIImgTools()
     36//      Désacative (cache) la fenêtre "PIImgTools" (méthode statique).
     37//--
     38
    1039// ------ Menu des options et fenetre de dialogue pour changement de LUT --------
     40
    1141
    1242PIImgTools* PIImgTools::curlutw = NULL;
    … …  
    1646if (curlutw == NULL)  curlutw = new PIImgTools(PIApplicationGetApp());
    1747curlutw->Show();
     48}
     49
     50/* --Methode-- */
     51void PIImgTools::HidePIImgTools()
     52{
     53if (curlutw == NULL)  return;
     54curlutw->Hide();
    1855}
    1956

  • trunk/SophyaPI/PI/piimgtools.h

    r389 r537  
    2323  static PIImgTools* curlutw;
    2424  static void ShowPIImgTools();
     25  static void HidePIImgTools();
    2526protected:
    2627  virtual void  Process(PIMessage msg, PIMsgHandler* sender, void* data=NULL);

  • trunk/SophyaPI/PI/pioptmenugen.cc

    r535 r537  
    2828
    2929//++
    30 // Titre        Constructeurs
     30// Titre        Constructeurs
    3131//--
    3232//++
    … …  
    4444
    4545//++
    46 // Titre        Méthodes
     46// Titre        Méthodes
    4747//--
    4848

  • trunk/SophyaPI/PI/piscdrawwdg.cc

    r535 r537  
    495495// --------------------------------------------------------------------------
    496496
     497//++
     498// Class        PIYfXDrawer
     499// Lib          PI
     500// include      piscdrawwdg.h
     501//
     502//      Classe de traceur de points/fonctions Y = f(X).
     503//--
     504//++
     505// Links        Parents
     506// PIDrawer
     507//--
     508//++
     509// Links        Voir aussi
     510// P1DArrayAdapter
     511//--
     512//++
     513// Titre        Constructeur
     514//--
     515
     516//++
     517// PIYfXDrawer(P1DArrayAdapter* ax, P1DArrayAdapter* ay, bool ad)
     518//      Constructeur. Tracé de
     519//|      Y=ay->Value() = f(X= ax->Value()) si ax et ay != NULL
     520//|     Y=ax->Value() = f(X= ax->X())  si ay == NULL
     521//      Si "ad==true" les objets "ax" et "ay" sont détruits par
     522//      le destructeur de "PIYfXDrawer".
     523//--
     524
    497525/* --Methode-- */
    498526PIYfXDrawer::PIYfXDrawer(P1DArrayAdapter* ax, P1DArrayAdapter* ay, bool ad)
    … …  
    601629// Classe de traceur de fonction  double = f(fouble)
    602630//================================================================
     631
     632//++
     633// Class        PIFuncDrawer
     634// Lib          PI
     635// include      piscdrawwdg.h
     636//
     637//      Classe de traceur de fonctions Y = f(double X).
     638//--
     639//++
     640// Links        Parents
     641// PIDrawer
     642//--
     643//++
     644// Titre        Constructeur
     645//--
     646//++
     647//  PIFuncDrawer(FUNC f)
     648//      Cosntructeur de traceur d'une fonction "FUNC f" avec
     649//|     typedef double(*FUNC)(double)
     650//--
     651
    603652
    604653/* --Methode-- */

  • trunk/SophyaPI/PI/pisurfdr.cc

    r440 r537  
     1// Module PI : Peida Interactive     PISurfaceDrawer
     2// Traceur de surface 3D  - R.Ansari, C.Magneville 98
     3// LAL (Orsay) / IN2P3-CNRS  DAPNIA/SPP (Saclay) / CEA
     4
    15#include <math.h>
    26#include "pisurfdr.h"
     7
     8//++
     9// Class        PISurfaceDrawer
     10// Lib          PI
     11// include      pisurfdr.h
     12//
     13//      Classe de traceur d'une surface Z = f(X,Y)
     14//--
     15//++
     16// Links        Parents
     17// PIDrawer3D
     18//--
     19//++
     20// Links        Voir aussi
     21// P2DArrayAdapter
     22//--
     23//++
     24// Titre        Constructeur
     25//--
     26//++
     27//  PISurfaceDrawer(P2DArrayAdapter* arr, bool asxy=false, bool asz=true, bool ad = true)
     28//      Constructeur. Tracé d'une surface définie par le tableau 2D "arr".
     29//      Si asxy == true : Application d'un facteur d'échelle pour égaliser
     30//      le rapport d'aspect des deux axes X et Y
     31//      Si asz == true : Application d'un facteur d'échelle pour égaliser
     32//      le rapport d'aspect de l'axe Z par rapport a XY.
     33//--
    334
    435/* --Methode-- */

  • trunk/SophyaPI/PIext/basexecut.cc

    r506 r537  
    99#include "pdlmgr.h"
    1010#include "ctimer.h"
    11 // #include "dlftypes.h"
    1211
    1312#include "pistdimgapp.h"

  • trunk/SophyaPI/PIext/pihisto2d.cc

    r330 r537  
    77
    88//++
    9 // Class        PIHisto2D,PIH2DWdg,H2WinArg
    10 // Lib  PI
     9// Class        PIHisto2D
     10// Lib          PIext
    1111// include      pihisto2d.h
    1212//
    13 //      Classes de dessin des histogrammes a 2 dimensions.
    14 //--
    15 
    16 //++
    17 // Titre        Dessin d'un histogramme 2D.
     13//      Classes de dessin des histogrammes a 2 dimensions pour
     14//      objets *Histo2D*
     15//--
     16
     17//++
     18// Links        Parents
     19// PIDrawer
     20//--
     21
     22//++
     23// Titre        Constructeur, méthodes
    1824//--
    1925
    … …  
    373379//  Classe PIH2DWdg
    374380/////////////////////////////////////////////////////////////////
    375 //++
    376 // Titre        Widget de dessin d'un histogramme 2D.
     381
     382//++
     383// Class        PIH2DWdg
     384// Lib          PIext
     385// include      pihisto2d.h
     386//
     387//      Classe de composantes graphiques permettant la manipulation
     388//      de traceur d'histos 2D ("PIHisto2D")
     389//--
     390//++
     391// Links        Parents
     392// PIScDrawWdg
     393//--
     394//++
     395// Links        Voir aussi
     396// PIHisto2D
     397//--
     398
     399//++
     400// Titre        Constructeur, méthodes
    377401//--
    378402
    … …  
    496520/////////////////////////////////////////////////////////////////
    497521//++
    498 // Titre        Fenetre de dialogue pour le choix des options..
     522// Class        H2WinArg
     523// Lib          PIext
     524// include      pihisto2d.h
     525//
     526//      Fenêtre de dialogue pour le choix des options de tracé pour "PIHisto2D"
     527//      Classe de fenêtre de dialogue permettant de modifier interactivement
     528//      Les différents attributs de visualisation pour les *PIImage* .
     529//--
     530//++
     531// Links        Parents
     532// PIWindow
     533//--
     534//++
     535// Links        Voir aussi
     536// PIHisto2D
     537// PIH2DWdg
     538//--
     539
     540//++
     541// Titre        Constructeur, méthodes
    499542//--
    500543

  • trunk/SophyaPI/PIext/pintup3d.cc

    r486 r537  
     1// Peida Interactive   -   PI            R. Ansari 97-99
     2// Traceur3D (Drawer) pour NTupleInterface 
     3// LAL (Orsay) / IN2P3-CNRS  DAPNIA/SPP (Saclay) / CEA
     4
    15#include <stdio.h>
    26#include "pintup3d.h"
     7
     8//++
     9// Class        PINTuple3D
     10// Lib          PIext
     11// include      pintup3d.h
     12//
     13//      Classe de traceur 3D à partir des données
     14//      d'un objet implémentant l'interface *NTupleInterface*.
     15//      Les objets "PINTuple3D" peuvent tracer des signes (markers)
     16//      éventuellement avec des barres d'erreur et une étiquette
     17//      pour chaque point. Si un attribut de ligne, autre que
     18//      "PI_NotDefLineAtt" est spécifié, les points sont connectés
     19//      par une ligne.
     20//--
     21//++
     22// Links        Parents
     23// PIDrawer3D
     24//--
     25//++
     26// Links        Voir aussi
     27// NTupleInterface
     28// PINTuple
     29//--
     30
     31//++
     32// Titre        Constructeur
     33//--
     34//++
     35// PINTuple3D(NTupleInterface* nt, bool ad=false)
     36//      Constructeur. Si "ad == true", l'objet "nt" est détruit par
     37//      le destructeur de l'objet "PINTuple".
     38//      Note : nt doit être créé par new
     39//--
    340
    441 
    … …  
    1956  if (mAdDO && mNT)  delete mNT;
    2057}
     58
     59//++
     60// Titre        Méthodes
     61//--
     62//++
     63// void  SelectXYZ(const char* px, const char* py, const char* pz)
     64//      Choix des noms de colonnes X,Y,Z définissant les coordonnées des points.
     65//      Ces trois colonnes doivent être spécifiées pour obtenir un tracé.
     66// void  SelectErrBar(const char* erbx=NULL, const char* erby=NULL, const char* erbz=NULL)
     67//      Choix des noms de colonnes pour le tracé des barres d'erreur.
     68// void  SelectWt(const char* pw=NULL, int nbins=10)
     69//      Choix du nom de colonne poids. Dans ce cas, la taille du signe
     70//      (marker) sera proportionnel à la valeur de cette colonne pour
     71//      chaque point.
     72// void  SelectLabel(const char* plabel)
     73//      Choix du nom de colonne correspondant à l'étiquette.
     74//--
    2175
    2276/* --Methode-- */

  • trunk/SophyaPI/PIext/pintuple.cc

    r486 r537  
     1// Peida Interactive   -   PI        R. Ansari 97-99
     2// Traceur (Drawer) pour NTupleInterface 
     3// LAL (Orsay) / IN2P3-CNRS  DAPNIA/SPP (Saclay) / CEA
     4
    15#include <stdio.h>
    26#include "pintuple.h"
    37
     8//++
     9// Class        PINTuple
     10// Lib          PIext
     11// include      pintuple.h
     12//
     13//      Classe de traceur 2D (dans un plan) à partir des données
     14//      d'un objet implémentant l'interface *NTupleInterface*.
     15//      Les objets "PINTuple" peuvent tracer des signes (markers)
     16//      éventuellement avec des barres d'erreur et une étiquette
     17//      pour chaque point. Si un attribut de ligne, autre que
     18//      "PI_NotDefLineAtt" est spécifié, les points sont connectés
     19//      par une ligne.
     20//--
     21//++
     22// Links        Parents
     23// PIDrawer
     24//--
     25//++
     26// Links        Voir aussi
     27// NTupleInterface
     28// PINTuple3D
     29//--
     30
     31//++
     32// Titre        Constructeur
     33//--
     34//++
     35// PINTuple(NTupleInterface* nt, bool ad)
     36//      Cosntructeur. Si "ad == true", l'objet "nt" est détruit par
     37//      le destructeur de l'objet "PINTuple"
     38//      Note : nt doit être créé par new
     39//--
    440 
    541/* --Methode-- */
    … …  
    1955  if (mAdDO && mNT)  delete mNT;
    2056}
     57
     58//++
     59// Titre        Méthodes
     60//--
     61//++
     62// void  SelectXY(const char* px, const char* py)
     63//      Choix des noms de colonnes X,Y définissant les coordonnées des points.
     64//      Ces deux colonnes doivent être spécifiées pour obtenir un tracé.
     65// void  SelectErrBar(const char* erbx=NULL, const char* erby=NULL)
     66//      Choix des noms de colonnes pour le tracé des barres d'erreur.
     67// void  SelectWt(const char* pw=NULL, int nbins=10)
     68//      Choix du nom de colonne poids. Dans ce cas, la taille du signe
     69//      (marker) sera proportionnel à la valeur de cette colonne pour
     70//      chaque point.
     71// void  SelectLabel(const char* plabel=NULL)
     72//      Choix du nom de colonne correspondant à l'étiquette.
     73//--
    2174
    2275/* --Methode-- */
Note: See TracChangeset for help on using the changeset viewer.