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

Popular posts from this blog

plotting - Plot 4D data with color as 4th dimension

I have a list of 4D data (x position, y position, amplitude, wavelength). I want to plot x, y, and amplitude on a 3D plot and have the color of the points correspond to the wavelength. I have seen many examples using functions to define color but my wavelength cannot be expressed by an analytic function. Is there a simple way to do this? Answer Here a another possible way to visualize 4D data: data = Flatten[Table[{x, y, x^2 + y^2, Sin[x - y]}, {x, -Pi, Pi,Pi/10}, {y,-Pi,Pi, Pi/10}], 1]; You can use the function Point along with VertexColors . Now the points are places using the first three elements and the color is determined by the fourth. In this case I used Hue, but you can use whatever you prefer. Graphics3D[ Point[data[[All, 1 ;; 3]], VertexColors -> Hue /@ data[[All, 4]]], Axes -> True, BoxRatios -> {1, 1, 1/GoldenRatio}]

plotting - Filling between two spheres in SphericalPlot3D

Manipulate[ SphericalPlot3D[{1, 2 - n}, {θ, 0, Pi}, {ϕ, 0, 1.5 Pi}, Mesh -> None, PlotPoints -> 15, PlotRange -> {-2.2, 2.2}], {n, 0, 1}] I cant' seem to be able to make a filling between two spheres. I've already tried the obvious Filling -> {1 -> {2}} but Mathematica doesn't seem to like that option. Is there any easy way around this or ... Answer There is no built-in filling in SphericalPlot3D . One option is to use ParametricPlot3D to draw the surfaces between the two shells: Manipulate[ Show[SphericalPlot3D[{1, 2 - n}, {θ, 0, Pi}, {ϕ, 0, 1.5 Pi}, PlotPoints -> 15, PlotRange -> {-2.2, 2.2}], ParametricPlot3D[{ r {Sin[t] Cos[1.5 Pi], Sin[t] Sin[1.5 Pi], Cos[t]}, r {Sin[t] Cos[0 Pi], Sin[t] Sin[0 Pi], Cos[t]}}, {r, 1, 2 - n}, {t, 0, Pi}, PlotStyle -> Yellow, Mesh -> {2, 15}]], {n, 0, 1}]

plotting - Mathematica: 3D plot based on combined 2D graphs

I have several sigmoidal fits to 3 different datasets, with mean fit predictions plus the 95% confidence limits (not symmetrical around the mean) and the actual data. I would now like to show these different 2D plots projected in 3D as in but then using proper perspective. In the link here they give some solutions to combine the plots using isometric perspective, but I would like to use proper 3 point perspective. Any thoughts? Also any way to show the mean points per time point for each series plus or minus the standard error on the mean would be cool too, either using points+vertical bars, or using spheres plus tubes. Below are some test data and the fit function I am using. Note that I am working on a logit(proportion) scale and that the final vertical scale is Log10(percentage). (* some test data *) data = Table[Null, {i, 4}]; data[[1]] = {{1, -5.8}, {2, -5.4}, {3, -0.8}, {4, -0.2}, {5, 4.6}, {1, -6.4}, {2, -5.6}, {3, -0.7}, {4, 0.04}, {5, 1.0}, {1, -6.8}, {2, -4.7}, {3, -1....