Skip to main content

Pass Options to Export[]


I'm working with Options to change the look and feel of some generated Graphics by passing Options to several functions, one of them being Export[]. For example:


Options[myPlot] := {Resolution -> 325, Size -> 12, FileName -> "A", 
  PlotStyle -> Automatic};

myPlot[f_, opts : OptionsPattern[myPlot]] := Block[{fig},
(* ... some calculations here *)

fig = Plot[f[x], {x, -\[Pi], \[Pi]}, 
    Evaluate[FilterRules[{opts}, Options[Plot]]]];
fig = Show[fig, ImageSize -> OptionValue[Size]*72/2.54];+
Export[OptionValue[FileName] <> ".png", fig,  FilterRules[{opts}, Options[Export]]];
Print[fig];
]

And using f[x_] := x^2 use the function as


 myPlot[f, Resolution -> 120, PlotStyle -> Red]


The Option to plot the function in Red is passed correctly to Plot but Resolution is not passed to Export. This is of course due to the fact that Options[Export] = {}.


My question is:


How can I still pass Options to Export (i.e. how to determine, which are available, if they are not written in Options[Export]?


And closely related:


How to do that on your own, i.e. now I defined PlotStyle to be an Option of myPlot, though it's only passed on, how can I pass Options, that I haven't given myself, without getting the message



OptionValue::nodef: "Unknown option PlotStyle for ...




Answer



Extraction of Export options



To extract the options for specific image export formats automatically, I really don't know an easy way. What you can do is to use Trace in combination with ExportString to investigate what Mathematica is doing. To make the next thing work you have to call e.g. ExportString["test", "GIF"]; for every format at least once:


ExportString["test", #]; & /@ {"PNG", "GIF", "BMP", "JPEG"}

System`ConvertersDump`exportOptions /@ {"PNG", "GIF", "BMP", "JPEG"}
(*
{{"BitDepth", "ColorSpace", 
  "DataType"}, {"AnimationRepetitions", "Background", "FrameRate", 
  "TransitionEffect", "TransparentColor", 
  "UserInputFlag"}, {"BitDepth", "ColorSpace", "DataType", 
  "HorizontalResolution", "RLECompression", 

  "VerticalResolution"}, {"BitDepth", "ColorSpace"}}
*)

which is unfortunately very distinct from the documentation. For some exporters you find for instance such stuff


Options[System`ConvertersDump`exportGraphicsToGIFConverter]
(*
 {Background -> None, ImageResolution -> Automatic, 
 ImageSize -> Automatic, "ImageTopOrientation" -> Top, 
 "ColorReductionPalette" -> 256, "ColorReductionDither" -> True, 
 "GlobalColorMap" -> True}

*)

But how to find this automatically? I have no idea. Checkout this too


Options[System`ConvertersDump`exportToBitmapConverter]
Options[System`ConvertersDump`exportToColormappedBitmapConverter]

Setting up options for own functions


Say you want to setup a function which can take its own options, options of Plot and options of NMinimize. Furthermore, you want to specify some of the default option-values for Plot and NMinimize. You can set the function up and use it like follows:


Options[f] = {
   fopt1 -> Automatic,

   fopt2 -> True,
   PlotStyle -> Green,
   AccuracyGoal -> 1
   };


f[x_, opts : OptionsPattern[{f, Plot, NMinimize}]] := Module[{},
  Print["Given Options usable by f only:", 
   FilterRules[{opts}, Options[f]]];
  Print["Given Options usable by Plot only:", 

   FilterRules[{opts}, Options[Plot]]];
  Print["Given Options usable by NMinimize only:", 
   FilterRules[{opts}, Options[NMinimize]]];

  Print["Defaultvalue for not specified options:" ];
  Print[OptionValue[StepMonitor]];
  Print[OptionValue[PlotRange]];
  Print[OptionValue[fopt2]];
]


Test case


f[x, fopt1 -> Full, PlotStyle -> Yellow, AccuracyGoal -> 42]
(*
Given Options usable by f only:{fopt1->Full,PlotStyle->RGBColor[1,1,0],AccuracyGoal->42}
Given Options usable by Plot only:{PlotStyle->RGBColor[1,1,0]}
Given Options usable by NMinimize only:{AccuracyGoal->42}

Defaultvalue for not specified options:
None
{Full,Automatic}

True
*)

And now you can pass any other option of Plot or NMinimize without a warning. But be carful, something like Method is an option for many functions and would be passed to each approapriate.


Comments

Post a Comment

Popular posts from this blog

mathematical optimization - Minimizing using indices, error: Part::pkspec1: The expression cannot be used as a part specification

I want to use Minimize where the variables to minimize are indices pointing into an array. Here a MWE that hopefully shows what my problem is. vars = u@# & /@ Range[3]; cons = Flatten@ { Table[(u[j] != #) & /@ vars[[j + 1 ;; -1]], {j, 1, 3 - 1}], 1 vec1 = {1, 2, 3}; vec2 = {1, 2, 3}; Minimize[{Total@((vec1[[#]] - vec2[[u[#]]])^2 & /@ Range[1, 3]), cons}, vars, Integers] The error I get: Part::pkspec1: The expression u[1] cannot be used as a part specification. >> Answer Ok, it seems that one can get around Mathematica trying to evaluate vec2[[u[1]]] too early by using the function Indexed[vec2,u[1]] . The working MWE would then look like the following: vars = u@# & /@ Range[3]; cons = Flatten@{ Table[(u[j] != #) & /@ vars[[j + 1 ;; -1]], {j, 1, 3 - 1}], 1 vec1 = {1, 2, 3}; vec2 = {1, 2, 3}; NMinimize[ {Total@((vec1[[#]] - Indexed[vec2, u[#]])^2 & /@ R...
Post a Comment
Read more

functions - Get leading series expansion term?

Given a function f[x] , I would like to have a function leadingSeries that returns just the leading term in the series around x=0 . For example: leadingSeries[(1/x + 2)/(4 + 1/x^2 + x)] x and leadingSeries[(1/x + 2 + (1 - 1/x^3)/4)/(4 + x)] -(1/(16 x^3)) Is there such a function in Mathematica? Or maybe one can implement it efficiently? EDIT I finally went with the following implementation, based on Carl Woll 's answer: lds[ex_,x_]:=( (ex/.x->(x+O[x]^2))/.SeriesData[U_,Z_,L_List,Mi_,Ma_,De_]:>SeriesData[U,Z,{L[[1]]},Mi,Mi+1,De]//Quiet//Normal) The advantage is, that this one also properly works with functions whose leading term is a constant: lds[Exp[x],x] 1 Answer Update 1 Updated to eliminate SeriesData and to not return additional terms Perhaps you could use: leadingSeries[expr_, x_] := Normal[expr /. x->(x+O[x]^2) /. a_List :> Take[a, 1]] Then for your examples: leadingSeries[(1/x + 2)/(4 + 1/x^2 + x), x] leadingSeries[Exp[x], x] leadingSeries[(1/x + 2 + (1 - 1/x...
Post a Comment
Read more

What is and isn't a valid variable specification for Manipulate?

I have an expression whose terms have arguments (representing subscripts), like this: myExpr = A[0] + V[1,T] I would like to put it inside a Manipulate to see its value as I move around the parameters. (The goal is eventually to plot it wrt one of the variables inside.) However, Mathematica complains when I set V[1,T] as a manipulated variable: Manipulate[Evaluate[myExpr], {A[0], 0, 1}, {V[1, T], 0, 1}] (*Manipulate::vsform: Manipulate argument {V[1,T],0,1} does not have the correct form for a variable specification. >> *) As a workaround, if I get rid of the symbol T inside the argument, it works fine: Manipulate[ Evaluate[myExpr /. T -> 15], {A[0], 0, 1}, {V[1, 15], 0, 1}] Why this behavior? Can anyone point me to the documentation that says what counts as a valid variable? And is there a way to get Manpiulate to accept an expression with a symbolic argument as a variable? Investigations I've done so far: I tried using variableQ from this answer , but it says V[1...
Post a Comment
Read more