ROOT  6.06/09
Reference Guide
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TImageDump Class Reference

Save canvas as an image (GIF, JPEG, PNG, XPM, TIFF etc.).

Example:

$ root -b
root [0] .x hsimple.C
root [1] c1->Print("c1.gif");

TImageDump can be used in any mode (batch, interactive) as follows

TImageDump *imgdump = new TImageDump("test.png");
c1->Paint();
imgdump->Close();

Definition at line 33 of file TImageDump.h.

Public Member Functions

 TImageDump ()
 
 TImageDump (const char *filename, Int_t type=-111)
 Initialize batch image interface. More...
 
virtual ~TImageDump ()
 destructor More...
 
void CellArrayBegin (Int_t W, Int_t H, Double_t x1, Double_t x2, Double_t y1, Double_t y2)
 cell array begin More...
 
void CellArrayFill (Int_t r, Int_t g, Int_t b)
 Cell array fill. More...
 
void CellArrayEnd ()
 Cell array end. More...
 
void Close (Option_t *opt="")
 Close a image file. More...
 
void DrawBox (Double_t x1, Double_t y1, Double_t x2, Double_t y2)
 Draw a Box. More...
 
void DrawFrame (Double_t xl, Double_t yl, Double_t xt, Double_t yt, Int_t mode, Int_t border, Int_t dark, Int_t light)
 Draw a Frame around a box. More...
 
void DrawPolyMarker (Int_t n, Float_t *x, Float_t *y)
 not used More...
 
void DrawPolyMarker (Int_t n, Double_t *x, Double_t *y)
 draw polymarker More...
 
void DrawPS (Int_t n, Float_t *xw, Float_t *yw)
 not used More...
 
void DrawPS (Int_t n, Double_t *xw, Double_t *yw)
 This function defines a path with xw and yw and draw it according the value of nn: More...
 
void NewPage ()
 new page More...
 
void Open (const char *filename, Int_t type=-111)
 Open a image file. More...
 
void Text (Double_t x, Double_t y, const char *string)
 Draw text. More...
 
void Text (Double_t x, Double_t y, const wchar_t *string)
 Draw text. More...
 
void SetColor (Float_t r, Float_t g, Float_t b)
 Set color with its R G B components. More...
 
voidGetStream () const
 
void SetType (Int_t type=-111)
 
Int_t GetType () const
 
TImageGetImage () const
 
- Public Member Functions inherited from TVirtualPS
 TVirtualPS ()
 
 TVirtualPS (const char *filename, Int_t type=-111)
 VirtualPS constructor. More...
 
virtual ~TVirtualPS ()
 VirtualPS destructor. More...
 
virtual void PrintFast (Int_t nch, const char *string="")
 Fast version of Print. More...
 
virtual void PrintStr (const char *string="")
 Output the string str in the output buffer. More...
 
virtual void WriteInteger (Int_t i, Bool_t space=kTRUE)
 Write one Integer to the file. More...
 
virtual void WriteReal (Float_t r, Bool_t space=kTRUE)
 Write a Real number to the file. More...
 
virtual void PrintRaw (Int_t len, const char *str)
 Print a raw. More...
 
virtual void SetStream (std::ofstream *os)
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual ~TNamed ()
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void SetName (const char *name)
 Change (i.e. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Change (i.e. set) all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Change (i.e. set) the title of the TNamed. More...
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
- Public Member Functions inherited from TAttLine
 TAttLine ()
 AttLine default constructor. More...
 
 TAttLine (Color_t lcolor, Style_t lstyle, Width_t lwidth)
 AttLine normal constructor. More...
 
virtual ~TAttLine ()
 AttLine destructor. More...
 
void Copy (TAttLine &attline) const
 Copy this line attributes to a new TAttLine. More...
 
Int_t DistancetoLine (Int_t px, Int_t py, Double_t xp1, Double_t yp1, Double_t xp2, Double_t yp2)
 Compute distance from point px,py to a line. More...
 
virtual Color_t GetLineColor () const
 
virtual Style_t GetLineStyle () const
 
virtual Width_t GetLineWidth () const
 
virtual void Modify ()
 Change current line attributes if necessary. More...
 
virtual void ResetAttLine (Option_t *option="")
 Reset this line attributes to default values. More...
 
virtual void SaveLineAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1, Int_t widdef=1)
 Save line attributes as C++ statement(s) on output stream out. More...
 
virtual void SetLineAttributes ()
 Invoke the DialogCanvas Line attributes. More...
 
virtual void SetLineColor (Color_t lcolor)
 
virtual void SetLineColorAlpha (Color_t lcolor, Float_t lalpha)
 Set a transparent line color. More...
 
virtual void SetLineStyle (Style_t lstyle)
 
virtual void SetLineWidth (Width_t lwidth)
 
 ClassDef (TAttLine, 2)
 
- Public Member Functions inherited from TAttFill
 TAttFill ()
 
 TAttFill (Color_t fcolor, Style_t fstyle)
 AttFill normal constructor. More...
 
virtual ~TAttFill ()
 AttFill destructor. More...
 
void Copy (TAttFill &attfill) const
 Copy this fill attributes to a new TAttFill. More...
 
virtual Color_t GetFillColor () const
 
virtual Style_t GetFillStyle () const
 
virtual Bool_t IsTransparent () const
 
virtual void Modify ()
 Change current fill area attributes if necessary. More...
 
virtual void ResetAttFill (Option_t *option="")
 Reset this fill attributes to default values. More...
 
virtual void SaveFillAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1001)
 Save fill attributes as C++ statement(s) on output stream out. More...
 
virtual void SetFillAttributes ()
 Invoke the DialogCanvas Fill attributes. More...
 
virtual void SetFillColor (Color_t fcolor)
 
virtual void SetFillColorAlpha (Color_t fcolor, Float_t falpha)
 Set a transparent fill color. More...
 
virtual void SetFillStyle (Style_t fstyle)
 
- Public Member Functions inherited from TAttMarker
 TAttMarker ()
 
 TAttMarker (Color_t color, Style_t style, Size_t msize)
 TAttMarker normal constructor. More...
 
virtual ~TAttMarker ()
 TAttMarker destructor. More...
 
void Copy (TAttMarker &attmarker) const
 Copy this marker attributes to a new TAttMarker. More...
 
virtual Color_t GetMarkerColor () const
 
virtual Style_t GetMarkerStyle () const
 
virtual Size_t GetMarkerSize () const
 
virtual void Modify ()
 Change current marker attributes if necessary. More...
 
virtual void ResetAttMarker (Option_t *toption="")
 Reset this marker attributes to the default values. More...
 
virtual void SaveMarkerAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1, Int_t sizdef=1)
 Save line attributes as C++ statement(s) on output stream out. More...
 
virtual void SetMarkerAttributes ()
 Invoke the DialogCanvas Marker attributes. More...
 
virtual void SetMarkerColor (Color_t mcolor=1)
 
virtual void SetMarkerColorAlpha (Color_t mcolor, Float_t malpha)
 Set a transparent marker color. More...
 
virtual void SetMarkerStyle (Style_t mstyle=1)
 
virtual void SetMarkerSize (Size_t msize=1)
 
 ClassDef (TAttMarker, 2)
 
- Public Member Functions inherited from TAttText
 TAttText ()
 
 TAttText (Int_t align, Float_t angle, Color_t color, Style_t font, Float_t tsize)
 AttText normal constructor. More...
 
virtual ~TAttText ()
 AttText destructor. More...
 
void Copy (TAttText &atttext) const
 Copy this text attributes to a new TAttText. More...
 
virtual Short_t GetTextAlign () const
 
virtual Float_t GetTextAngle () const
 
virtual Color_t GetTextColor () const
 
virtual Font_t GetTextFont () const
 
virtual Float_t GetTextSize () const
 
virtual void Modify ()
 Change current text attributes if necessary. More...
 
virtual void ResetAttText (Option_t *toption="")
 Reset this text attributes to default values. More...
 
virtual void SaveTextAttributes (std::ostream &out, const char *name, Int_t alidef=12, Float_t angdef=0, Int_t coldef=1, Int_t fondef=61, Float_t sizdef=1)
 Save text attributes as C++ statement(s) on output stream out. More...
 
virtual void SetTextAttributes ()
 Invoke the DialogCanvas Text attributes. More...
 
virtual void SetTextAlign (Short_t align=11)
 
virtual void SetTextAngle (Float_t tangle=0)
 
virtual void SetTextColor (Color_t tcolor=1)
 
virtual void SetTextColorAlpha (Color_t tcolor, Float_t talpha)
 Set a transparent marker color. More...
 
virtual void SetTextFont (Font_t tfont=62)
 
virtual void SetTextSize (Float_t tsize=1)
 
virtual void SetTextSizePixels (Int_t npixels)
 Set the text size in pixels. More...
 

Protected Member Functions

Int_t XtoPixel (Double_t x)
 x to pixel More...
 
Int_t YtoPixel (Double_t y)
 y to pixel More...
 
void DrawDashPolyLine (Int_t npoints, TPoint *pt, UInt_t nDash, const char *pDash, const char *col, UInt_t thick)
 draw dashed polyline More...
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

Protected Attributes

TImagefImage
 
Int_t fType
 
- Protected Attributes inherited from TVirtualPS
Int_t fNByte
 
Int_t fLenBuffer
 
Int_t fSizBuffer
 
Bool_t fPrinted
 
std::ofstream * fStream
 
char * fBuffer
 
const char * fImplicitCREsc
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 
- Protected Attributes inherited from TAttLine
Color_t fLineColor
 
Style_t fLineStyle
 
Width_t fLineWidth
 
- Protected Attributes inherited from TAttFill
Color_t fFillColor
 
Style_t fFillStyle
 
- Protected Attributes inherited from TAttMarker
Color_t fMarkerColor
 
Style_t fMarkerStyle
 
Size_t fMarkerSize
 
- Protected Attributes inherited from TAttText
Float_t fTextAngle
 
Float_t fTextSize
 
Short_t fTextAlign
 
Color_t fTextColor
 
Font_t fTextFont
 

Additional Inherited Members

- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

#include <TImageDump.h>

+ Inheritance diagram for TImageDump:
+ Collaboration diagram for TImageDump:

Constructor & Destructor Documentation

TImageDump::TImageDump ( )
TImageDump::TImageDump ( const char *  fname,
Int_t  wtype = -111 
)

Initialize batch image interface.

fname : image file name

The possible workstation types are:

  • 111 - Portrait
  • 112 - Landscape
  • 114 - preview, keep in memory (do not write on delete)

Definition at line 73 of file TImageDump.cxx.

TImageDump::~TImageDump ( )
virtual

destructor

Definition at line 94 of file TImageDump.cxx.

Member Function Documentation

void TImageDump::CellArrayBegin ( Int_t  W,
Int_t  H,
Double_t  x1,
Double_t  x2,
Double_t  y1,
Double_t  y2 
)
virtual

cell array begin

Implements TVirtualPS.

Definition at line 714 of file TImageDump.cxx.

void TImageDump::CellArrayEnd ( )
virtual

Cell array end.

Implements TVirtualPS.

Definition at line 756 of file TImageDump.cxx.

void TImageDump::CellArrayFill ( Int_t  r,
Int_t  g,
Int_t  b 
)
virtual

Cell array fill.

Implements TVirtualPS.

Definition at line 743 of file TImageDump.cxx.

void TImageDump::Close ( Option_t opt = "")
virtual

Close a image file.

Implements TVirtualPS.

Definition at line 107 of file TImageDump.cxx.

Referenced by ~TImageDump().

void TImageDump::DrawBox ( Double_t  x1,
Double_t  y1,
Double_t  x2,
Double_t  y2 
)
virtual

Draw a Box.

Implements TVirtualPS.

Definition at line 121 of file TImageDump.cxx.

void TImageDump::DrawDashPolyLine ( Int_t  npoints,
TPoint pt,
UInt_t  nDash,
const char *  pDash,
const char *  col,
UInt_t  thick 
)
protected

draw dashed polyline

Definition at line 621 of file TImageDump.cxx.

Referenced by DrawPS().

void TImageDump::DrawFrame ( Double_t  x1,
Double_t  y1,
Double_t  x2,
Double_t  y2,
Int_t  mode,
Int_t  bordersize,
Int_t  dark,
Int_t  light 
)
virtual

Draw a Frame around a box.

  • mode = -1 the box looks as it is behind the screen
  • mode = 1 the box looks as it is in front of the screen border is the border size in already pre-computed dark is the color for the dark part of the frame light is the color for the light part of the frame

Implements TVirtualPS.

Definition at line 195 of file TImageDump.cxx.

void TImageDump::DrawPolyMarker ( Int_t  n,
Float_t x,
Float_t y 
)
virtual

not used

Implements TVirtualPS.

Definition at line 276 of file TImageDump.cxx.

void TImageDump::DrawPolyMarker ( Int_t  n,
Double_t x,
Double_t y 
)
virtual

draw polymarker

Implements TVirtualPS.

Definition at line 286 of file TImageDump.cxx.

void TImageDump::DrawPS ( Int_t  n,
Float_t xw,
Float_t yw 
)
virtual

not used

Implements TVirtualPS.

Definition at line 611 of file TImageDump.cxx.

Referenced by DrawBox().

void TImageDump::DrawPS ( Int_t  nn,
Double_t x,
Double_t y 
)
virtual

This function defines a path with xw and yw and draw it according the value of nn:

  • If nn > 0 a line is drawn.
  • If nn < 0 a closed polygon is drawn.

Implements TVirtualPS.

Definition at line 451 of file TImageDump.cxx.

TImage* TImageDump::GetImage ( ) const
inline

Definition at line 67 of file TImageDump.h.

void* TImageDump::GetStream ( ) const
inlinevirtual

Reimplemented from TVirtualPS.

Definition at line 64 of file TImageDump.h.

Int_t TImageDump::GetType ( ) const
inlinevirtual

Reimplemented from TVirtualPS.

Definition at line 66 of file TImageDump.h.

void TImageDump::NewPage ( )
virtual

new page

Implements TVirtualPS.

Definition at line 643 of file TImageDump.cxx.

void TImageDump::Open ( const char *  filename,
Int_t  type = -111 
)
virtual

Open a image file.

Implements TVirtualPS.

Definition at line 83 of file TImageDump.cxx.

Referenced by TImageDump().

void TImageDump::SetColor ( Float_t  r,
Float_t  g,
Float_t  b 
)
virtual

Set color with its R G B components.

  • r: % of red in [0,1]
  • g: % of green in [0,1]
  • b: % of blue in [0,1]

Implements TVirtualPS.

Definition at line 786 of file TImageDump.cxx.

void TImageDump::SetType ( Int_t  type = -111)
inlinevirtual

Reimplemented from TVirtualPS.

Definition at line 65 of file TImageDump.h.

void TImageDump::Text ( Double_t  x,
Double_t  y,
const char *  chars 
)
virtual

Draw text.

  • x: x position of the text
  • y: y position of the text

Implements TVirtualPS.

Definition at line 659 of file TImageDump.cxx.

void TImageDump::Text ( Double_t  x,
Double_t  y,
const wchar_t *  chars 
)
virtual

Draw text.

  • x: x position of the text
  • y: y position of the text

Implements TVirtualPS.

Definition at line 682 of file TImageDump.cxx.

Int_t TImageDump::XtoPixel ( Double_t  x)
protected

x to pixel

Definition at line 793 of file TImageDump.cxx.

Referenced by CellArrayBegin(), DrawBox(), DrawFrame(), DrawPolyMarker(), DrawPS(), and Text().

Int_t TImageDump::YtoPixel ( Double_t  y)
protected

y to pixel

Definition at line 801 of file TImageDump.cxx.

Referenced by CellArrayBegin(), DrawBox(), DrawFrame(), DrawPolyMarker(), DrawPS(), and Text().

Member Data Documentation

TImage* TImageDump::fImage
protected
Int_t TImageDump::fType
protected

Definition at line 36 of file TImageDump.h.

Referenced by Close(), GetType(), and Open().


The documentation for this class was generated from the following files: